A self hosted livestreaming server.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
knotteye 7107cb4c8f Update documentation for new repository host 1 year ago
config Big Refactor 2 years ago
docs Update documentation for new repository host 1 year ago
install Update documentation 1 year ago
site Fix bug 1 year ago
src Expose whether cluster mode is enabled over /api/instance/config 1 year ago
templates Fix bug 1 year ago
.gitignore Big commit. Implement handlers for everything that's currently rendered server side in the client-side frontend. 1 year ago
CONTRIBUTORS Add contributors file 2 years ago
LICENSE Add package.json and LICENSE, name the project. 2 years ago
README.md Update documentation for new repository host 1 year ago
package-lock.json Add a dependency for xmpp mirroring and add configurability 1 year ago
package.json Add a dependency for xmpp mirroring and add configurability 1 year ago
tsconfig.json Changed init functions to be more consistent. 2 years ago

README.md

Satyr: A livestreaming server

System dependencies: A stable version of node>=10, mysql3 (or a compatible implementation such as MariaDB), and ffmpeg >=4.2

Setup Instructions

git clone https://pond.waldn.net/git/knotteye/satyr.git
cd satyr
npm install
npm run setup

Follow the instructions after setup runs.

Run the server

npm run start

You can also skip checking the database version and compiling templates (if you don't use server-side rendering) on startup.

npm run start -- --skip-migrate --skip-compile
# don't forget to migrate manually when you update
npm run migrate
# and compile templates after any changes
npm run make-templates

Contributing

  1. Fork the repository
  2. Create new feature branch
  3. Write Code
  4. Create an request to merge back into develop