jerkerolofsson/subsceneserver repository overview

⁠Docker compose

services:

  subscene_server:
    image: jerkerolofsson/subsceneserver:0.1.1
    restart: always
    environment:
      SUBSCENE_DATA: /data
    networks:
      - subscene_net
    ports:
      - 8080:8080
    volumes:
      - "/path-to-dump:/data"

  subscene_mysql:
    image: mysql
    command: --default-authentication-plugin=mysql_native_password
    restart: always
    networks:
      - subscene_net
    environment:
      MYSQL_ROOT_PASSWORD: password

networks:
  subscene_net:
    driver: bridge

⁠Setup

1. Extract the Subscene V2 dump file on host
2. Edit the docker compose file and replace path-to-dump with the folder the dump file was extracted to. Note: the folder should contain the .sql file from the dump.
3. Run docker-compose up - d
4. Go to http://ip:8080⁠
5. Click setup in the menu and then click the start button and wait for the subscene database to be imported

⁠Notes on search

Subtitles from the subscene dump can be stored in zip or rar files, and each zip may contain multiple files inside. For API convenience, the server will scan inside zip files which affects performance but has the advantage of finding an exact subtitle file.

⁠API

⁠Search by text query

/api/search?q=

⁠Search by IMDB ID, season, episode

/api/query?imdbId=1190634&season=2&episode=6

⁠Search by title, year

/api/query?title=Gladiator&year=2000

All queries returns found subtitles in a json array. The json array contains a relative download URL

⁠Download

/api/download/{file ID}/{filename}