IcyNetwork
/
icytv
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add license and readme

This commit is contained in:
Evert Prants 2019-10-24 20:52:38 +03:00
parent 3e632dd91f
commit 2e5e6412b9
Signed by: evert
GPG Key ID: 1688DA83D222D0B5
2 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
The MIT License
Copyright (c) 2019 Evert "Diamond" Prants <evert@lunasqu.ee>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

17
README.md Normal file
View File

@ -0,0 +1,17 @@
# Icy TV
This application provides means of authentication when using the [nginx-rtmp-module](https://github.com/arut/nginx-rtmp-module) NGINX module via a configured OAuth2 provider. It also includes a player (powered by [hls.js](https://github.com/video-dev/hls.js/)) that provides viewer counts using WebSockets.
## Setup
Using this application requires an instance of [NGINX](https://nginx.org/). See [nginx.example.conf] for example configuration. Another thing you need is a running instance of [Redis](https://redis.io) in order to store sessions. And finally, you need an OAuth2 provider.
1. Clone this repository
2. `npm install`
3. Copy the example configuration `config.example.toml` to `config.toml` and edit it
4. `npm run build` to build the front-end scripts
5. `npm start` to run in production (requires an HTTPS proxy!), `npm run serve` to run in development mode
## Developing
Run the front-end watch task using `npm run watch`.
## License
The MIT License