matthew/satyr
1
0
Fork 0
mirror of https://git.waldn.net/git/knotteye/satyr.git synced 2025-09-23 09:42:55 +00:00
Code Issues Projects Releases Wiki Activity

Remove long winded installation guide

Browse Source 
Add config guide
Minor changes to default config
This commit is contained in:
knotteye
2019-10-05 15:11:03 -05:00
parent cd8b9780d7
commit fad832fe38
7 changed files with 32 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/CONFIGURATION.md Normal file
View File

@ -0,0 +1,26 @@
## Configuring Satyr
### Config file
All changes to satyr's config will go in the config/local.toml file
Some values you might want to change are
```
[satyr]
registration = true
#allow new users to register
rootRedirect = '/users/live'
#the page users are directed to when they visit your site root
[media]
record = true
#allow users to record VODs
[bcrypt]
saltRounds = 12
#change the number of rounds of bcrypt to fit your hardware
#if you don't understand the implications, don't change this
[ircd]
enable = true
#enable IRC peering
```
### Web Frontend
If you want to customize the front-end css, place a file with any changes you wish to make at site/local.css
You can change the logo by replacing site/logo.svg, or edit templates/base.njk to look for another source.