knotteye
/
satyr
Archived
1
0
Fork 0
Code Issues Pull Requests Releases 5 Wiki Activity
A self hosted livestreaming server.
This repository has been archived on 2021-01-16. You can view files and clone it, but cannot push or open issues/pull-requests.
144 Commits
2 Branches
11 Tags
2.4 MiB
TypeScript 69.8%
HTML 18.9%
JavaScript 7.8%
Shell 1.9%
CSS 1.1%
Other 0.5%
 
 
 
 
 
 
Go to file
knotteye 54a891dac1 Update documentation 2020-10-16 22:25:24 -05:00
config Big Refactor 2019-12-21 08:59:35 -06:00
docs Update documentation 2020-10-16 22:25:24 -05:00
install Add config option to turn server side rendering off. 2020-10-16 21:31:23 -05:00
site Big commit. Implement handlers for everything that's currently rendered server side in the client-side frontend. 2020-10-14 07:44:19 -05:00
src Make server side rendering fully configurable 2020-10-16 21:57:24 -05:00
templates Update documentation 2020-10-16 22:25:24 -05:00
.gitignore Big commit. Implement handlers for everything that's currently rendered server side in the client-side frontend. 2020-10-14 07:44:19 -05:00
CONTRIBUTORS Add contributors file 2019-11-05 17:22:52 -06:00
LICENSE Add package.json and LICENSE, name the project. 2019-09-15 12:23:09 -05:00
README.md Add config option to turn server side rendering off. 2020-10-16 21:31:23 -05:00
package-lock.json Big commit. Implement handlers for everything that's currently rendered server side in the client-side frontend. 2020-10-14 07:44:19 -05:00
package.json Bump major version. There were some breaking changes in there somewhere 2020-10-14 07:51:26 -05:00
tsconfig.json Changed init functions to be more consistent. 2019-09-26 14:43:24 -05:00

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 skip checking the database version and compiling templates (if you don't use server-side rendering) on startup.

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