summaryrefslogtreecommitdiff
path: root/README.md
blob: 7ee902d56930ee347fa93ce467ecb489cdc3932c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<div align="center">
    <img src="https://git.spacekookie.de/brook/plain/logo.png" />
    <h1>brook</h1>
</div>

A minimal self-hostable streaming setup.


## Setup

`brook` is a modular project, meaning that many different components
come together to provide a simple and relatively lightweight streaming
setup.  Following is a quick overview of components.

* `ffmpeg` - running an rtmp server, and converting video to `dash`
  output format
* `nginx` - serves the `dash` directory
* `index.html` - static html file with js for a dash player and xmpp
  web chat
* `brook-metrics` - the only custom server-side program to track
  viewer metrics
* `prosody` - An XMPP server to back the chat room