2019-09-24 18:42:13 -05:00
|
|
|
## Satyr: A livestreaming server
|
2019-09-24 18:35:11 -05:00
|
|
|
|
|
|
|
|
System dependencies: A stable version of node>=10, mysql3 (or a compatible implementation such as MariaDB), and ffmpeg >=4.2
|
|
|
|
|
|
2020-07-20 04:25:01 -05:00
|
|
|
### Setup Instructions
|
2019-09-24 18:35:11 -05:00
|
|
|
```bash
|
|
|
|
|
git clone https://gitlab.com/knotteye/satyr.git
|
|
|
|
|
cd satyr
|
|
|
|
|
npm install
|
2019-10-05 15:11:03 -05:00
|
|
|
npm run setup
|
2019-09-24 18:35:11 -05:00
|
|
|
```
|
2019-10-20 16:30:23 -05:00
|
|
|
Follow the instructions after setup runs.
|
2019-09-24 18:35:11 -05:00
|
|
|
|
2019-09-24 18:42:13 -05:00
|
|
|
### Run the server
|
2019-09-24 18:35:11 -05:00
|
|
|
```bash
|
2020-10-10 15:55:32 -05:00
|
|
|
npm run start
|
|
|
|
|
```
|
|
|
|
|
You can also run this to skip checking the database version on startup.
|
|
|
|
|
```bash
|
|
|
|
|
npm run start -- --skip-migrate
|
|
|
|
|
# don't forget to migrate manually when you update
|
|
|
|
|
npm run migrate
|
2019-09-24 18:42:13 -05:00
|
|
|
```
|
2020-07-04 10:09:06 -05:00
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
1. Fork the repository
|
|
|
|
|
2. Create new feature branch
|
|
|
|
|
3. Write Code
|
|
|
|
|
4. Create an request to merge back into develop
|
