From 0bde9e0b86cd6cb34dce06f5c491746c88d41ad2 Mon Sep 17 00:00:00 2001 From: knotteye Date: Sat, 27 Jun 2020 23:39:57 -0500 Subject: [PATCH] Update documentation --- docs/INSTALLATION.md | 13 ++++++++----- templates/help.njk | 10 ++++++---- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 0058c81..136d9a3 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -3,9 +3,12 @@ A more detailed walkthrough. ### System Dependencies 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. +See [this page](https://nodejs.org/en/download/package-manager/) for instructions on installing node v10. +If the version in your distro's package manager is different, you can install 'n' through npm to manage node versions. ### Installing Satyr +Before starting, you should create a system user to run the satyr service. + Clone the repository and change to the directory ```bash git clone https://gitlab.com/knotteye/satyr.git @@ -19,7 +22,7 @@ Run the setup script to generate a config file and database setup. ```bash npm run setup ``` -Look over the generated config file in config/generated.toml, and move it to config/local.toml when you're satisfied. +Look over the generated config file in config/generated.yml, and move it to config/config.yml when you're satisfied. Run the setup script for the database. ```bash sudo mysql @@ -30,11 +33,11 @@ Then start the server. npm run start ``` -It is reccomended that you run Satyr behind a TLS terminating reverse proxy, like nginx. +It is reccomended that you run Satyr behind a TLS terminating reverse proxy like nginx. An example configuration can be found in CONFIGURATION.md An example systemd service is provided at install/satyr.service. It assumes you've installed satyr into /opt/satyr, and created a satyr user with the home directory /var/lib/satyr for the purpose of running the service. ## Updating Satyr -Updating should be as simple as pulling the latest code and dependencies, then building and restarting the server. +Updating should be as simple as pulling the latest code and dependencies, then restarting the server. ```bash git pull @@ -45,4 +48,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 and site directories 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 the config and site directories to the new location. \ No newline at end of file diff --git a/templates/help.njk b/templates/help.njk index fdfc607..c0bdaa8 100644 --- a/templates/help.njk +++ b/templates/help.njk @@ -4,12 +4,14 @@

Chatting

The webclient for chat can be accessed on the streamer's page, or at https://{{ domain }}/chat

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 cvcvcv Available only in your own room if you are a streamer. Forcefully disconnect the user.
-/ban cvcvcv (time) Ban a user from your room. Bans are based on IP address. The optional time is in minutes. The default is 30.
+/nick sally (password) Password is only required if sally is a registered user.
+/join sally Join the chatroom for sally's stream and leave the previous room.
+/kick bob Available only in your own room if you are a streamer. Forcefully disconnect the user.
+/ban bob (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
+
+Chat rooms can also be mirrored to discord channels, IRC channels, and twitch streams. Ask the instance administrator if these are available.

Streaming

Users should stream to rtmp://{{ domain }}/stream/Stream-Key