Go to file
Mike Lang aa89c358da Hacky workaround for segments that can't be played independently
.github/workflows Also build zulip_bots in CI
api_ping Pin argh to avoid stupid breaking changes
backfiller backfiller: Include channel name being backfilled in logs
chat_archiver Fix bugs with chat_archiver
common Hacky workaround for segments that can't be played independently
cutter cuter: local upload backends: Use _ instead of - as replacement char
db_scripts use a UTC timestamp
downloader downloader: Hard-code source quality for non-twitch providers
monitoring grafana: Disable analytics
nginx Fix all old references to github.com/ekimekim/wubloader
playlist_manager Pin argh to avoid stupid breaking changes
postgres Fix all old references to github.com/ekimekim/wubloader
restreamer Hacky workaround for segments that can't be played independently
segment_coverage Pin argh to avoid stupid breaking changes
sheetsync sheetsync: Support archive sheet
thrimbletrimmer thrimbletrimmer: Change default download type to smart
thrimshim thrimshim: Special handling for "archive" events
zulip_bots schedulebot: Don't set groups before the run starts
.gitignore improve gitignore for local python installs
.gitmodules chat-archiver: Early work and basic archival
.prettierrc.yaml Auto-format JS files with prettier
.travis.yml Add ability to explicitly pull and re-use layers from other commits when building
DATABASE.md Database changes for thumbnails
INSTALL.md Fix all old references to github.com/ekimekim/wubloader
LICENSE Update LICENSE
README.md Some extra documentation on chat_archiver
SecurityModel.md Update SecurityModel.md
build Fix all old references to github.com/ekimekim/wubloader
docker-compose.jsonnet docker-compose: Add support for backfill only, chat only channels
generate-docker-compose replace readlink -f with realpath in build scripts
generate-flamegraph generate-flamegraph: Script to create a flamegraph by querying prometheus
get-build-tag replace readlink -f with realpath in build scripts
initial-design-doc.pdf Add initial design doc
k8s.jsonnet Fix all old references to github.com/ekimekim/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.
  • segment_coverage regularly checks whether there is complete segment coverage for each hour.
  • playlist_manager adds videos to youtube playlists depending on tags.
  • chat_archiver records twitch chat messages and merges them with records from other nodes.
  • 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.

There is also a kubernetes-based option, but it is less configurable and only supports replication nodes. See k8s.jsonnet for details.

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