knotteye
/
satyr
Archived
1
0
Fork 0
Code Issues Pull Requests Releases 5 Wiki Activity

Update documentation

merge-requests/8/head
knotteye 2020-06-27 23:39:57 -05:00
parent b2759c5298
commit 0bde9e0b86
2 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/INSTALLATION.md
View File

@ -3,9 +3,12 @@ A more detailed walkthrough.
### System Dependencies ### System Dependencies
Install ffmpeg(>= 4.2.1) and mysql through your distribution's package manager. 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 ### Installing Satyr
Before starting, you should create a system user to run the satyr service.
Clone the repository and change to the directory Clone the repository and change to the directory
```bash ```bash
git clone https://gitlab.com/knotteye/satyr.git 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 ```bash
npm run setup 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. Run the setup script for the database.
```bash ```bash
sudo mysql sudo mysql
@ -30,11 +33,11 @@ Then start the server.
npm run start 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. 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 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 ```bash
git pull git pull
@ -45,4 +48,4 @@ npm update
Then restart the server. Then restart the server.
## Migrating Satyr ## 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. 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.

10
templates/help.njk
View File

@ -4,12 +4,14 @@
<h4>Chatting</h4> <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 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> The following commands are available:</br>
<code><a>/nick kawen (password)</a></code> Password is only required if kawen is a registered user.</br> <code><a>/nick sally (password)</a></code> Password is only required if sally 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>/join sally</a></code> Join the chatroom for sally'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>/kick bob</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>/ban bob (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>/banlist</a></code> List the IPs currently banned from your room.</br>
<code><a>/unban (ip)</a></code> self explanatory</br> <code><a>/unban (ip)</a></code> self explanatory</br>
</br>
Chat rooms can also be mirrored to discord channels, IRC channels, and twitch streams. Ask the instance administrator if these are available.
<h4>Streaming</h4> <h4>Streaming</h4>
Users should stream to <a>rtmp://{{ domain }}/stream/Stream-Key</a></br></br> Users should stream to <a>rtmp://{{ domain }}/stream/Stream-Key</a></br></br>