knotteye
/
satyr
Archived
1
0
Fork 0
Code Issues Pull Requests Releases 5 Wiki Activity
This repository has been archived on 2021-01-16. You can view files and clone it, but cannot push or open issues/pull-requests.
satyr/README.md

681 B
Raw Blame History

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://gitlab.com/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 run this to skip checking the database version on startup.

npm run start -- --skip-migrate
# don't forget to migrate manually when you update
npm run migrate

Contributing

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