Satyr needs access to port 1935 for RTMP streams, and will serve HTTP on port 8000. See CONFIGURATION.md for details on changing this.
For HTTPS, run a reverse proxy in front of satyr. An example nginx config can be found at install/satyr.nginx An example systemd service can also be at install/satyr.service
Satyr's CLI tool can be run with
npm run cli or
It's not very complex. The following commands are available:
npm run cli -- --adduser sally --password "hunter12"to create user sally with the password hunter12
npm run cli -- --rmuser sallyto remove user sally
npm run cli -- --inviteto generate an invite code used for creating account even when registration is closed
If registration is open, users can register at your.site.com/registration, and set some options such as whether to record VODs and a stream title on /profile.
Chat is based on Socket.IO, and can be accessed through the webclient at /chat. Chatting and changing a nickname do not require authentication, but the usernames of streamers are reserved.
The following commands are available:
/nick sally (password)Password is only required if sally is a registered user.
/join sallyJoin the chatroom for sally's stream and leave the previous room.
/kick bobAvailable 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.
/banlistList the IPs currently banned from your room.
/unban (ip)self explanatory
You can set up mirroring to and from webchat rooms and IRC channels, twitch streams, and discord server channels. More information is in CONFIGURATION.md
Users should stream to rtmp://example.tld/stream/examplestreamkey The stream will be available at rtmp://example.tld/live/kawen and http://example.tld/live/kawen/index.mpd
Most software, such as OBS, will have a separate field for the URL and stream key, in which case the user can enter rtmp://example.tld/stream/ and the stream key in the appropriate field.