summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 45 insertions, 1 deletions
diff --git a/README.md b/README.md
index 5e34d98..8d092fb 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
<div align="center">
- <img src="https://git.spacekookie.de/brook/plain/logo.png" width="256px"/>
+ <img src="https://git.spacekookie.de/brook/plain/docs/logo.png" width="256px"/>
<h1>brook</h1>
</div>
@@ -21,3 +21,47 @@ setup. Following is a quick overview of components.
viewer metrics
* `prosody` - An XMPP server to back the chat room
+
+## Configuration
+
+I'm running my brook instance on NixOS, and as such a lot of the
+configuration is Nix specific. For other linux distributions, or to
+consider a reference implementation for other systems, check the
+[`common`](./common) directory.
+
+### NixOS
+
+If you are already running an nginx, or prosody, you will have to
+manually integrate [`nix`](./nix) into your configuration. In case
+you don't, you can simply include the whole module.
+
+```nix
+imports = [
+ /path/to/brook/nix
+];
+```
+
+Then you can use the various `brook` submodules to configure your
+streaming setup. If you want to use XMPP chats, you need to configure
+prosody yourself - `brook` will only setup the anonymous user virtualhost
+to be used by the brook-web chat.
+
+```nix
+services.brook = {
+ nginx = {
+ enable = true;
+ hostAddr = "stream.spacekookie.de";
+ acmeHost = "spacekookie.de";
+ };
+
+ prosody = {
+ enable = true;
+ certRoot = "/var/lib/acme/spacekookie.de";
+ };
+
+ dash = {
+ enable = true;
+ name = "kookie.tv";
+ };
+};
+```