wubloader/README.md

Wubloader is a system for saving, re-serving and cutting into videos of a target
twitch (or probably other HLS, but some twitch specifics are assumed) stream.

It was designed to serve the needs of the [Video Strike Team](https://vst.ninja)
as part of [Desert Bus For Hope](https://desertbus.org).

A full design doc can be read at [initial-design-doc.pdf](./initial-design-doc.pdf),
but a brief overview of the components:

* Downloader grabs segments from twitch and saves them to disk
* Restreamer serves segments from disk as well as playlist files allowing them to be streamed
* Backfiller queries restreamers of other servers in order to pick up segments this server doesn't have already,
  ie. it replicates missing segments.
* Cutter interacts with a database to perform cutting jobs
* Sheet Sync syncs specifc database columns to a google doc which is the primary operator interface.

### Usage

All components are built as docker images.
Components which access the disk expect a shared directory mounted at `/mnt`.

A docker-compose file is provided to run all components. See `docker-compose.jsonnet`
to set configuration options, then generate the compose file with `./generate-docker-compose`.
Then run `docker-compose up`.
Add a basic README 6 years ago			`Wubloader is a system for saving, re-serving and cutting into videos of a target`
			`twitch (or probably other HLS, but some twitch specifics are assumed) stream.`

			`It was designed to serve the needs of the [Video Strike Team](https://vst.ninja)`
			`as part of [Desert Bus For Hope](https://desertbus.org).`

Fix readme internal link 6 years ago			`A full design doc can be read at [initial-design-doc.pdf](./initial-design-doc.pdf),`
Add a basic README 6 years ago			`but a brief overview of the components:`

			`* Downloader grabs segments from twitch and saves them to disk`
			`* Restreamer serves segments from disk as well as playlist files allowing them to be streamed`
			`* Backfiller queries restreamers of other servers in order to pick up segments this server doesn't have already,`
			`ie. it replicates missing segments.`
			`* Cutter interacts with a database to perform cutting jobs`
			`* Sheet Sync syncs specifc database columns to a google doc which is the primary operator interface.`

common: Basic config and bustime code 6 years ago			`### Usage`

Add a basic README 6 years ago			`All components are built as docker images.`
			Components which access the disk expect a shared directory mounted at `/mnt`.
Set up a docker compose file to run all images For ease-of-use, we use a jsonnet file to generate the yaml. Jsonnet is a language for generating JSON documents. In this case it's useful to us because it lets us have comments, references to settings defined at the top, and some basic logic like converting qualities from a list of strings to a comma-seperated string. To avoid requiring jsonnet to be installed, we use the official jsonnet docker image in the generate script. 6 years ago
			A docker-compose file is provided to run all components. See `docker-compose.jsonnet`
			to set configuration options, then generate the compose file with `./generate-docker-compose`.
			Then run `docker-compose up`.