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.

32 lines
822 B

1 year ago
  1. ## Satyr: A livestreaming server
  2. System dependencies: A stable version of node>=10, mysql3 (or a compatible implementation such as MariaDB), and ffmpeg >=4.2
  3. ### Setup Instructions
  4. ```bash
  5. git clone https://pond.waldn.net/git/knotteye/satyr.git
  6. cd satyr
  7. npm install
  8. npm run setup
  9. ```
  10. Follow the instructions after setup runs.
  11. ### Run the server
  12. ```bash
  13. npm run start
  14. ```
  15. You can also skip checking the database version and compiling templates (if you don't use server-side rendering) on startup.
  16. ```bash
  17. npm run start -- --skip-migrate --skip-compile
  18. # don't forget to migrate manually when you update
  19. npm run migrate
  20. # and compile templates after any changes
  21. npm run make-templates
  22. ```
  23. ## Contributing
  24. 1. Fork the repository
  25. 2. Create new feature branch
  26. 3. Write Code
  27. 4. Create an request to merge back into develop