From 97d4678a0a99bab235c61037231299e1b8af0690 Mon Sep 17 00:00:00 2001
From: knotteye <knotteye@airmail.cc>
Date: Sat, 21 Dec 2019 17:23:00 -0600
Subject: [PATCH] Update documentation to match recent changes with config and
 chat

---
 docs/CONFIGURATION.md | 34 +++++++++++++++++-----------------
 docs/INSTALLATION.md  |  4 ++--
 docs/USAGE.md         |  3 +++
 templates/help.njk    |  9 ++++++---
 4 files changed, 28 insertions(+), 22 deletions(-)

diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md
index 54e848b..43f4cfe 100644
--- a/docs/CONFIGURATION.md
+++ b/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
diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md
index 0f9dbd2..0058c81 100644
--- a/docs/INSTALLATION.md
+++ b/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.
\ No newline at end of file
+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.
\ No newline at end of file
diff --git a/docs/USAGE.md b/docs/USAGE.md
index 38014d9..d8a35a1 100644
--- a/docs/USAGE.md
+++ b/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
diff --git a/templates/help.njk b/templates/help.njk
index 432eb09..fdfc607 100644
--- a/templates/help.njk
+++ b/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>