diff --git a/INSTALL.md b/INSTALL.md index 288d8b2..17bf10e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -51,7 +51,7 @@ By default the `downloader`, `restreamer`, `backfiller`, `cutter`, `thrimshim`, If you are running a `cutter` you will have to place the appropriate Google credentials in a JSON file given by the `cutter_creds_file`. Likewise, if you are running the `sheetsync` service, you will have to place the appropriate credentials in the JSON file pointed to by `sheetsync_creds_file` as well as set the appropriate `sheet_id` and `worksheets` for the Google sheet to sync with. You will also need to set the appropriate `edit_url` to access `thrimbletrimmer`. -## Running the wubloader +## Running Wubloader To start the wubloader, simply run @@ -61,7 +61,7 @@ To stop the wubloader and clean up, simply run `docker-compose down` -## Database setup +## Database Setup When setting up a database node, a number of database specific options can be set. diff --git a/README.md b/README.md index 9e5d3e8..fed5370 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ but a brief overview of the components: * `nginx` provides a webserver through which the other components are exposed to the outside world. * `monitoring` provides dashboards to allow the wubloader to be monitored. -### Usage +### Installation All components are built as docker images. Components which access the disk expect a shared directory mounted at `/mnt`. @@ -46,8 +46,14 @@ A docker-compose file is provided to run all components. See `docker-compose.jso to set configuration options, then generate the compose file with `./generate-docker-compose`. Then run `docker-compose up`. +To install wubloader, please refer to [INSTALL.md](./INSTALL.md) for more granular steps. + +#### Alternate Setups + +> [!WARNING] +> Here be dragons. This config is largely maintained by one user and is not kept at parity with the rest of the tooling. It's highly suggested to not use at this juncture for new developers to wubloader. + There is also a kubernetes-based option, but it is less configurable and only fully supports replication and editing nodes. Basic support for running the database and playlist_manager has been added, but not tested. See [k8s.jsonnet](./k8s.jsonnet) for details. -Further details of installing and configuring the backfiller are provided in [INSTALL.md](./INSTALL.md).