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: 14 days 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 (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-21T19:36:31.000Z (10 months ago)
• Last Synced: 2024-04-22T14:48:53.971Z (7 months ago)
• Topics: docker, rsync, sponsorblock, sqlite
• Language: Shell
• Homepage:
• Size: 120 KB
• Stars: 158
• Watchers: 14
• Forks: 22
• Open Issues: 13
• 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.

---

[![sb-mirror](https://img.shields.io/docker/image-size/mchangrh/sb-mirror/alpine?label=sb-mirror)](https://hub.docker.com/r/mchangrh/sb-mirror)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](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)