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.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
satyr/README.md

31 lines
681 B

## Satyr: A livestreaming server
System dependencies: A stable version of node>=10, mysql3 (or a compatible implementation such as MariaDB), and ffmpeg >=4.2
4 years ago
### Setup Instructions
```bash
git clone https://gitlab.com/knotteye/satyr.git
cd satyr
npm install
npm run setup
```
Follow the instructions after setup runs.
### Run the server
```bash
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
```
4 years ago
## Contributing
1. Fork the repository
2. Create new feature branch
3. Write Code
4. Create an request to merge back into develop