Go to file
renovate[bot] 7243b2b0e1 fix(deps): update rust crate serde to v1.0.203 2024-05-25 18:06:11 +00:00
.github chore(deps): update docker/login-action action to v3 2023-09-12 21:13:05 +01:00
migrations Add index for videoID. 2022-10-30 17:59:17 +00:00
src Remove unsafe block and switch to safe mutex 2023-08-08 21:43:23 +09:00
.dockerignore Add files to deploy on docker-compose. 2022-10-22 21:43:13 +01:00
.env Initial commit. 2022-10-22 13:28:40 +01:00
.gitignore Initial commit. 2022-10-22 13:28:40 +01:00
Cargo.lock fix(deps): update rust crate serde to v1.0.203 2024-05-25 18:06:11 +00:00
Cargo.toml fix(deps): update rust crate serde to 1.0.200 2024-05-01 19:39:43 +00:00
Dockerfile Remove libssl package 2023-07-26 20:53:22 +01:00
Dockerfile.ci Build application outside docker for ci. 2022-10-25 10:19:41 +01:00
LICENSE Initial commit 2022-10-22 13:30:03 +01:00
README.md Remove sb.theairplan.com 2023-05-02 10:52:40 -04:00
Rocket.toml Add cors for official instance. 2022-10-25 10:13:34 +01:00
diesel.toml Initial commit. 2022-10-22 13:28:40 +01:00
docker-compose.yml chore(deps): update postgres docker tag to v16 2023-09-16 00:04:41 +00:00
renovate.json platformAutomerge should be outside 2022-11-03 23:09:06 +00:00

README.md

sponsorblock-mirror

This is a Rust-based mirror of the SponsorBlock API.

It also uses sb-mirror for mirroring the CSV dumps via rsync.

Instances

Feel free to add your instance to this list by making a pull request.

You can also configure Piped-Backend to use your mirror by changing the SPONSORBLOCK_SERVERS configuration value.

Compatibility

This implementation does not implement the full SponsorBlock server API. It supports hash-based queries to /api/skipSegments/<hash>, with optional categories parameter, and queries to /api/skipSegments with required videoID and optional categories parameters.

The browser extension works with only the hash-based query endpoint, but other clients, such as the one in ReVanced, require the video ID endpoint, and additionally query /api/userInfo and /api/isUserVip. Right now there are stub implementations for these. ReVanced had not yet been verified as compatible.

Using with Docker Compose

To run the server under Docker Compose, run:

docker compose up

This starts the API server, a database, and a mirroring service to download the SponsorBlock data from the sponsorblock.kavin.rocks mirror and keep it up to date.

The API will be available on http://localhost:8000. For example, you can try http://localhost:8000/api/skipSegments/aabf or http://localhost:8000/api/skipSegments?videoID=eQ_8F4nzyiw. It will take a few minutes at least for the database to download and import, so these will not return data on the first run.

Building

To make a local release build, use cargo build --release. This will produce a binary in target/release/sponsorblock-mirror.

To make a Docker container, you need to do a BuildKit Docker build, not a normal Docker build. Make sure you have buildx available in your Docker, and run:

docker buildx build --load -t 1337kavin/sponsorblock-mirror .

Troubleshooting

  • If the linker complains about a missing -lpq, make sure you have the PostgreSQL development libraries, which may be in a libpq-dev package or your distribution's equivalent.

  • If Docker complains that the --mount option requires BuildKit, make sure you are building with docker buildx build and not docker build.

  • To access the PostgreSQL database directly, you can docker exec -ti postgres-sb-mirror bash -c 'psql $POSTGRES_DB $POSTGRES_USER'.

  • Requests for videos not in the database are forwarded to https://sponsor.ajay.app/, which may be down or malfunctioning. A response of the string Internal Server Error is likely to be from there, rather than from this application.