From 2e5e6412b9aa12a74e856336b0a99d8159ca66f4 Mon Sep 17 00:00:00 2001 From: Evert Prants Date: Thu, 24 Oct 2019 20:52:38 +0300 Subject: [PATCH] Add license and readme --- LICENSE | 21 +++++++++++++++++++++ README.md | 17 +++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f71d6eb --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2019 Evert "Diamond" Prants + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6358688 --- /dev/null +++ b/README.md @@ -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