knotteye 8caad60a43 | ||
---|---|---|
config | ||
docs | ||
install | ||
site | ||
src | ||
templates | ||
.gitignore | ||
CONTRIBUTORS | ||
LICENSE | ||
README.md | ||
package-lock.json | ||
package.json | ||
tsconfig.json |
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://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
- Fork the repository
- Create new feature branch
- Write Code
- Create an request to merge back into develop