Go to file
Ajay 8eb6f5b2ea Merge branch 'master' of https://github.com/ajayyy/SponsorBlockServer 2024-05-07 15:37:59 -04:00
.github Add error server 2024-04-16 03:01:44 -04:00
containers Increase frequency of docker forgets 2024-04-27 00:42:55 -04:00
databases Fix index for hashed video id dearrow fetching 2024-01-09 15:31:56 -05:00
docker Update redis config 2023-02-03 12:31:30 -05:00
src Merge branch 'master' of https://github.com/ajayyy/SponsorBlockServer 2024-05-07 15:37:59 -04:00
test Make returned video duration in getBranding.ts consistent 2024-05-04 21:56:03 +02:00
.editorconfig migrate to typescript 2020-10-26 19:13:30 +02:00
.eslintrc.js Add eslint rules for dealing with promises 2022-09-07 20:01:11 -04:00
.gitignore add nyc output to gitignore 2022-09-24 22:46:16 -04:00
.nycrc.json add getIP test cases, misc others 2022-09-24 22:51:20 -04:00
DatabaseSchema.md add innerTube as primary videoInfo endpoint 2022-09-15 17:02:33 -04:00
Dockerfile Attempt to fix docker build error 2024-03-17 13:40:53 -04:00
LICENSE Relicense project to AGPL 2022-12-26 23:18:43 -05:00
LICENSE.old Relicense project to AGPL 2022-12-26 23:18:43 -05:00
README.MD Relicense project to AGPL 2022-12-26 23:18:43 -05:00
ci.json remove tests for maxNumberOfActiveWarnings 2023-02-22 00:35:58 -05:00
codecov.yml non-blocking coverage tests 2023-11-04 18:03:05 -04:00
config.json.example add minUserIDLength config option 2022-12-17 23:35:13 -05:00
entrypoint.sh Only create blank config if it doesn't exist 2022-11-01 14:21:33 -04:00
nodemon.json fix nodemon to watch .ts files 2020-11-01 17:29:57 +02:00
package-lock.json Bump express from 4.18.2 to 4.19.2 2024-03-28 17:17:43 +00:00
package.json Bump express from 4.18.2 to 4.19.2 2024-03-28 17:17:43 +00:00
test.json Merge pull request #541 from mchangrh/etagTest 2023-02-22 01:38:41 -05:00
tsconfig.json add innerTube as primary videoInfo endpoint 2022-09-15 17:02:33 -04:00

README.MD

SponsorBlock Server

SponsorBlock is an extension that will skip over sponsored segments of YouTube videos. SponsorBlock is a crowdsourced browser extension that let's anyone submit the start and end time's of sponsored segments of YouTube videos. Once one person submits this information, everyone else with this extension will skip right over the sponsored segment.

This is the server backend for it

Server

This uses a Postgres or Sqlite database to hold all the timing data.

To make sure that this project doesn't die, I have made the database publicly downloadable at https://sponsor.ajay.app/database. You can download a backup or get archive.org to take a backup if you do desire. The database is under this license unless you get explicit permission from me.

Hopefully this project can be combined with projects like this and use this data to create a neural network to predict when sponsored segments happen. That project is sadly abandoned now, so I have decided to attempt to revive this idea.

Client

The client web browser extension is available here: https://github.com/ajayyy/SponsorBlock

Build Yourself

This is a node.js server, so clone this repo and run npm install to install all dependencies.

Make sure to put the database files in the ./databases folder if you want to use a pre-existing database. Otherwise, a fresh database will be created.

Rename config.json.example to config.json and fill the parameters inside. Make sure to remove the comments as comments are not supported in JSON.

Ensure all the tests pass with npm test

Run the server with npm start.

Developing

If you want to make changes, run npm run dev to automatically reload the server and run tests whenever a file is saved.

API Docs

Available here

License

This is licensed under AGPL-3.0-only.