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

33 lines
822 B
Markdown
Raw Normal View History

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://pond.waldn.net/git/knotteye/satyr.git
2019-09-24 18:35:11 -05:00
cd satyr
npm install
npm run setup
2019-09-24 18:35:11 -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
npm run start
```
You can also skip checking the database version and compiling templates (if you don't use server-side rendering) on startup.
```bash
npm run start -- --skip-migrate --skip-compile
# don't forget to migrate manually when you update
npm run migrate
# and compile templates after any changes
npm run make-templates
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