satyr/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
```bash
git clone https://pond.waldn.net/git/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 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
```

## Contributing

1. Fork the repository
2. Create new feature branch
3. Write Code
4. Create an request to merge back into develop
Fixed headers. Oops. 2019-09-24 18:42:13 -05:00			`## Satyr: A livestreaming server`
Moved readme, started documentation. 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`

Update readme 2020-07-20 04:25:01 -05:00			`### Setup Instructions`
Moved readme, started documentation. 2019-09-24 18:35:11 -05:00			```bash
Update documentation for new repository host 2020-10-17 23:37:34 -05:00			`git clone https://pond.waldn.net/git/knotteye/satyr.git`
Moved readme, started documentation. 2019-09-24 18:35:11 -05:00			`cd satyr`
			`npm install`
Remove long winded installation guide Add config guide Minor changes to default config 2019-10-05 15:11:03 -05:00			`npm run setup`
Moved readme, started documentation. 2019-09-24 18:35:11 -05:00			```
Add more detailed installation instructions Add example systemd service 2019-10-20 16:30:23 -05:00			`Follow the instructions after setup runs.`
Moved readme, started documentation. 2019-09-24 18:35:11 -05:00
Fixed headers. Oops. 2019-09-24 18:42:13 -05:00			`### Run the server`
Moved readme, started documentation. 2019-09-24 18:35:11 -05:00			```bash
Implement database versioning and migration. It could not possibly be any simpler or easier to break, but it works. And it can be used to automatically migrate to a better system for migration later. For now, the way it works is by creating a new migration script with the name of the version (increment by one, whole numbers) in the src/db folder On start up, it will compare version numbers and run new scripts. The user can also manually check for migrations and skip the automatic checking. Added a bit of additional logging to see what's happening in the startup process as well. 2020-10-10 15:55:32 -05:00			`npm run start`
			```
Add config option to turn server side rendering off. Ensure templates are precompiled before starting the server. 2020-10-16 21:31:23 -05:00			`You can also skip checking the database version and compiling templates (if you don't use server-side rendering) on startup.`
Implement database versioning and migration. It could not possibly be any simpler or easier to break, but it works. And it can be used to automatically migrate to a better system for migration later. For now, the way it works is by creating a new migration script with the name of the version (increment by one, whole numbers) in the src/db folder On start up, it will compare version numbers and run new scripts. The user can also manually check for migrations and skip the automatic checking. Added a bit of additional logging to see what's happening in the startup process as well. 2020-10-10 15:55:32 -05:00			```bash
Add config option to turn server side rendering off. Ensure templates are precompiled before starting the server. 2020-10-16 21:31:23 -05:00			`npm run start -- --skip-migrate --skip-compile`
Implement database versioning and migration. It could not possibly be any simpler or easier to break, but it works. And it can be used to automatically migrate to a better system for migration later. For now, the way it works is by creating a new migration script with the name of the version (increment by one, whole numbers) in the src/db folder On start up, it will compare version numbers and run new scripts. The user can also manually check for migrations and skip the automatic checking. Added a bit of additional logging to see what's happening in the startup process as well. 2020-10-10 15:55:32 -05:00			`# don't forget to migrate manually when you update`
			`npm run migrate`
Add config option to turn server side rendering off. Ensure templates are precompiled before starting the server. 2020-10-16 21:31:23 -05:00			`# and compile templates after any changes`
			`npm run make-templates`
Fixed headers. Oops. 2019-09-24 18:42:13 -05:00			```
Update README.md 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`