https://github.com/mchangrh/sb-mirror
Docker containers to mirror the SponsorBlock database + API
https://github.com/mchangrh/sb-mirror
docker rsync sponsorblock sqlite
Last synced: about 1 month ago
JSON representation
Docker containers to mirror the SponsorBlock database + API
- Host: GitHub
- URL: https://github.com/mchangrh/sb-mirror
- Owner: mchangrh
- License: other
- Created: 2021-09-30T18:40:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-20T01:15:45.000Z (7 months ago)
- Last Synced: 2025-04-04T02:44:10.318Z (about 1 month ago)
- Topics: docker, rsync, sponsorblock, sqlite
- Language: Shell
- Homepage:
- Size: 120 KB
- Stars: 205
- Watchers: 15
- Forks: 31
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# SponsorBlock Mirror
Docker containers to mirror the [SponsorBlock](https://sponsor.ajay.app) database + API
SponsorBlock data and databases are under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) from https://sponsor.ajay.app.
---
[](https://hub.docker.com/r/mchangrh/sb-mirror)
[](https://opensource.org/licenses/MIT)
[](https://www.gnu.org/licenses/gpl-3.0)
## Usage
This copies the latest SponsorBlock database to the `./sb-mirror` local directory
```sh
docker run --rm -it -v "${PWD}/sb-mirror:/mirror" mchangrh/sb-mirror:alpine
```
docker-compose
```yml
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](./docs/containers.md)
---
Contributions & Pull request are always welcome & appreciated
non-exhaustive list of packages & respective licences [here](./oss-attribution/attribution.md)
There are no longer any public mirrors that offer rsync downloads
---
Special thanks to [Ajay](https://ajay.app/), [SponsorBlock](https://github.com/ajayyy/SponsorBlock/graphs/contributors), [SponsorBlockServer](https://github.com/ajayyy/SponsorBlockServer/graphs/contributors) and [SponsorBlockSite](https://github.com/ajayyy/SponsorBlockSite/graphs/contributors) contributors, SponsorBlock VIPs and the community for their contributions.
Don't be shy! Join us on [Discord](https://discord.gg/SponsorBlock) or [Matrix](https://matrix.to/#/#sponsor:ajay.app)