Update INSTALL.md

pull/70/head
Christopher Usher 5 years ago
parent 56c9a68c82
commit b4ce8fdbb6

@ -33,8 +33,9 @@ Alternatively if you have `git` installed you can clone the git repository:
You can edit the `docker-compose.jsonnet` file to set the configuration options. Important options include:
* `channel`, the Twitch channel to capture from
* `segments_path`, the local path to save segements to
* TODO add more
* `segments_path`, the local path to save segments to
* `db_args`, the arguments for connecting to the wubloader database
* `ports`, the ports to expose each service on. Only the `nginx` port (default on port 80) needs to be externally accessible for a non-database node as all the other services are routed thought `nginx`.
To generate the `docker-compose.yml` file used by `docker-compose`, run `generate-docker-compose`
@ -42,6 +43,8 @@ To generate the `docker-compose.yml` file used by `docker-compose`, run `generat
After making any changes to `docker-compose.jsonnet`, you will need to rerun `generate-docker-compose`.
By default the `downloader`, `restreamer`, `backfiller`, `cutter`, `thrimshim` and `nginx` services of the wubloader will be run. To change which services are run edit the `enabled` object in `docker-compose.jsonnet`. A complete wubloader set up also requires one and only one `database` service (though having a backup database is a good idea) and one and only one `sheetsync` service. TODO: explain how to setup database
## Running the wubloader
To start the wubloader, simply run
@ -52,5 +55,4 @@ To stop the wubloader and clean up, simply run
`docker-compose down`
TODO what ports need to be exposed ....
To backfill from a node, the other nodes need to know about it. The best way to do this is to add the node to the database's nodes table.

Loading…
Cancel
Save