Update documentation to match recent changes with config and chat

This commit is contained in:
knotteye
2019-12-21 17:23:00 -06:00
parent df8c803e25
commit 97d4678a0a
4 changed files with 28 additions and 22 deletions

View File

@@ -1,29 +1,29 @@
## Configuring Satyr
### Config file
All changes to satyr's config will go in the config/local.toml file
All changes to satyr's config will go in the config/config.yml file
Some values you might want to change are
```
[satyr]
registration = true
satyr:
registration: true
# allow new users to register
rootRedirect = '/users/live'
rootRedirect: '/users/live'
# the page users are directed to when they visit your site root
[server.http]
hsts = true
http:
hsts: true
# enable strict transport security
[media]
record = true
media:
record: true
# allow users to record VODs
[transcode]
adapative = true
transcode:
adapative: true
# enable adaptive livestreaming
# will help users with poor connections, but EXTREMELY cpu intensive
# even 3 variants will max out most budget VPSs with a single stream
variants = 3
variants: 3
# the number of adaptive streaming variants to generate
# satyr will always copy the source stream
# and the remaining variants will lower the quality incrementally
@@ -31,15 +31,15 @@ variants = 3
# So the default setting of 3 will copy the source stream once
# And generate two lower quality & bitrate variants
[bcrypt]
saltRounds = 12
crypto:
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
#extremely beta
irc:
port: 6667
#irc settings
#currently unused
```
### Web Frontend