Skip to content

Docker containers to mirror the SponsorBlock database API

License

Notifications You must be signed in to change notification settings

mchangrh/sb-mirror

Repository files navigation

SponsorBlock Mirror

Docker containers to mirror the SponsorBlock database API

SponsorBlock data and databases are under CC BY-NC-SA 4.0 from https://sponsor.ajay.app.


sb-mirror License: MIT License: GPL v3

Usage

This copies the latest SponsorBlock database to the ./sb-mirror local directory

docker run --rm -it -v "${PWD}/sb-mirror:/mirror" mchangrh/sb-mirror:alpine

docker-compose

sb-mirror:
  image: mchangrh/sb-mirror
  container_name: sb-mirror
  volumes:
    - ./mirror:/mirror
    - ./export:/export
  ports:
    - 873:873
  environment:
  # - MIRROR=TRUE # enable cronjob
  # - MIRROR_URL=mirror.sb.mchang.xyz # override to set upstream mirror 
  # - SQLITE=FALSE # generate .db in /export  

Mirroring

If you would like to set up an active mirror, allow 873/tcp through your firewalls for rsyncd and uncomment lines in docker-compose

If you would like to set up a full API mirror, see containers


Contributions & Pull request are always welcome & appreciated

non-exhaustive list of packages & respective licences here

There are no longer any public mirrors that offer rsync downloads


Special thanks to Ajay, SponsorBlock, SponsorBlockServer and SponsorBlockSite contributors, SponsorBlock VIPs and the community for their contributions.

Don't be shy! Join us on Discord or Matrix