diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..1003850 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +<div align="center"> + <img src="./logo.svg" /> + <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 + |