Browse Source

Update documentation to match recent changes with config and chat

merge-requests/7/head
knotteye 3 years ago
parent
commit
97d4678a0a
  1. 34
      docs/CONFIGURATION.md
  2. 4
      docs/INSTALLATION.md
  3. 3
      docs/USAGE.md
  4. 9
      templates/help.njk

34
docs/CONFIGURATION.md

@ -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

4
docs/INSTALLATION.md

@ -27,7 +27,7 @@ source install/db_setup.sql;
```
Then start the server.
```bash
npm start
npm run start
```
It is reccomended that you run Satyr behind a TLS terminating reverse proxy, like nginx.
@ -45,4 +45,4 @@ npm update
Then restart the server.
## Migrating Satyr
To backup and restore, you will need to export the mysqlDB. Restore the new database from the backup, then copy config/local.toml, config/jwt.pem, and the site directory to the new location.
To backup and restore, you will need to export the mysqlDB. Restore the new database from the backup, then copy config and site directories to the new location.

3
docs/USAGE.md

@ -52,6 +52,9 @@ The following commands are available:
`/nick kawen (password)` Password is only required if kawen is a registered user.
`/join kawen` Join the chatroom for kawen's stream and leave the previous room.
`/kick lain` Available only in your own room if you are a streamer. Forcefully disconnect the user.
`/ban lain (time)` Ban a user from your room. Bans are based on IP address. The optional time is in minutes. The default is 30.
`/banlist` List the IPs currently banned from your room.
`/unban (ip)` self explanatory
#### Streaming
Users should stream to rtmp://example.tld/stream/examplestreamkey

9
templates/help.njk

@ -4,9 +4,12 @@
<h4>Chatting</h4>
The webclient for chat can be accessed on the streamer's page, or at <a href="https://{{ domain }}/chat">https://{{ domain }}/chat</a></br></br>
The following commands are available:</br>
`/nick kawen (password)` Password is only required if kawen is a registered user.</br>
`/join kawen` Join the chatroom for kawen's stream and leave the previous room.</br>
`/kick cvcvcv` Available only in your own room if you are a streamer. Forcefully disconnect the user.</br>
<code><a>/nick kawen (password)</a></code> Password is only required if kawen is a registered user.</br>
<code><a>/join kawen</a></code> Join the chatroom for kawen's stream and leave the previous room.</br>
<code><a>/kick cvcvcv</a></code> Available only in your own room if you are a streamer. Forcefully disconnect the user.</br>
<code><a>/ban cvcvcv (time)</a></code> Ban a user from your room. Bans are based on IP address. The optional time is in minutes. The default is 30.</br>
<code><a>/banlist</a></code> List the IPs currently banned from your room.</br>
<code><a>/unban (ip)</a></code> self explanatory</br>
<h4>Streaming</h4>
Users should stream to <a>rtmp://{{ domain }}/stream/Stream-Key</a></br></br>

Loading…
Cancel
Save