Add adaptive livestreaming config docs.

docs/CONFIGURATION.md

@@ -6,22 +6,43 @@ Some values you might want to change are
 ```
 [satyr]
 registration = true
-#allow new users to register
+# allow new users to register
 rootRedirect = '/users/live'
-#the page users are directed to when they visit your site root
+# the page users are directed to when they visit your site root
+
+[server.http]
+hsts = true
+# enable strict transport security
+
 [media]
 record = true
-#allow users to record VODs
+# allow users to record VODs
+
+[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
+# the number of adaptive streaming variants to generate
+# satyr will always copy the source stream
+# and the remaining variants will lower the quality incrementally
+
+# So the default setting of 3 will copy the source stream once
+# And generate two lower quality & bitrate variants
+
 [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
-#unused for now
+#extremely beta
 ```
 
 ### 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.
+You should also consider editing templates/about.html and templates/tos.html

docs/INSTALLATION.md

@@ -2,8 +2,8 @@
 A more detailed walkthrough.
 
 ### System Dependencies
-Install ffmpeg and mysql through your distribution's package manager.
-See [this page](https://nodejs.org/en/download/package-manager/) for instructions on install node. Compatible versions are >=10. Nightly builds may fail to compile some of the native addons.
+Install ffmpeg(>= 4.2.1) and mysql through your distribution's package manager.
+See [this page](https://nodejs.org/en/download/package-manager/) for instructions on installing node. Compatible versions are >=10. Nightly builds may fail to compile some of the native addons.
 
 ### Installing Satyr
 Clone the repository and change to the directory
@@ -25,9 +25,8 @@ Run the setup script for the database.
 sudo mysql
 source install/db_setup.sql;
 ```
-Compile the code and start the server.
+Then start the server.
 ```bash
-npm run build
 npm start
 ```
 
@@ -40,10 +39,10 @@ Updating should be as simple as pulling the latest code and dependencies, then b
 ```bash
 git pull
 npm i
-npm run build
+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 the config/local.toml file and the site directory to the new install.
+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.