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 as part of Desert Bus For Hope.

A full design doc can be read at 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
• sheetsync syncs specifc database columns to a google doc which is the primary operator interface.
• thrimshim acts as an interface between the thrimbletrimmer editor and the database.
• thrimbletrimmer is a browser based video editor.
• database hosts a Postgres database to store events to be edited.
• nginx provides a webserver through which the other components are exposed to the outside world.
• common provides code shared between the other components.
• monitoring provides dashboards to allow the wubloader to be monitored.

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.

Further details of installing and configuring the backfiller are provided in INSTALL.md.