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.
191 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 34d6fa91df Fix some typos in documentation 2020-10-18 02:16:54 -05:00
config Big Refactor 2019-12-21 08:59:35 -06:00
docs Fix some typos in documentation 2020-10-18 02:16:54 -05:00
install Update documentation 2020-10-17 22:23:05 -05:00
site Fix bug 2020-10-17 22:40:30 -05:00
src Expose whether cluster mode is enabled over /api/instance/config 2020-10-17 22:08:56 -05:00
templates Fix bug 2020-10-17 22:40:30 -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 Update documentation for new repository host 2020-10-17 23:37:34 -05:00
package-lock.json Add a dependency for xmpp mirroring and add configurability 2020-10-17 16:55:55 -05:00
package.json Bump minor version 2020-10-17 23:41:37 -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://pond.waldn.net/git/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