diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml deleted file mode 100644 index 0feff00..0000000 --- a/.github/workflows/docker.yml +++ /dev/null @@ -1,47 +0,0 @@ -name: Build & Publish Sublogue Docker Image - -on: - push: - branches: [ "master" ] - tags: [ "v*" ] - -permissions: - contents: read - packages: write - -jobs: - build: - runs-on: ubuntu-latest - - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 - - - name: Login to GHCR - uses: docker/login-action@v3 - with: - registry: ghcr.io - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Docker Metadata - id: meta - uses: docker/metadata-action@v5 - with: - images: ghcr.io/${{ github.repository }} - tags: | - type=raw,value=latest - type=ref,event=branch - type=semver,pattern={{version}} - - - name: Build and Push - uses: docker/build-push-action@v5 - with: - context: . - push: true - platforms: linux/amd64,linux/arm64 - tags: ${{ steps.meta.outputs.tags }} - labels: ${{ steps.meta.outputs.labels }} diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 3e694dd..0000000 --- a/docs/README.md +++ /dev/null @@ -1,12 +0,0 @@ -# Sublogue - -**Sublogue** appends rich metadata, ratings, and plot summaries directly into subtitle files — cleanly, safely, and without breaking sync. - ---- - -## Features - -- 🎬 Plot + ratings injection -- ⏱ Sync-safe subtitle processing -- 🧠 OMDb + TMDb fallback logic -- 🖥 CLI + Web UI diff --git a/docs/_sidebar.md b/docs/_sidebar.md deleted file mode 100644 index b19eee3..0000000 --- a/docs/_sidebar.md +++ /dev/null @@ -1,7 +0,0 @@ -- Introduction - - [Overview](/) - - [Getting Started](getting-started.md) - -- Usage - - [CLI](cli.md) - - [Configuration](configuration.md) diff --git a/docs/documentation.html b/docs/documentation.html deleted file mode 100644 index a0ca36b..0000000 --- a/docs/documentation.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - - - - Sublogue Documentation - - - - - - - - - - - -
-
-
-
- - Sublogue -
-

Sublogue

-

Subtitle metadata orchestration

-
- - -
- -
- Overview - Features - Integrations - Getting started -
-
-
- -
-
-
-

Documentation

-

- Sublogue usage and setup -

-

- Sublogue is a lightweight, open source tool that enriches subtitle files with metadata and plot - summaries. It keeps timing intact, respects safe insertion windows, and lets you choose the metadata - provider per scan or per folder. -

-

- This page mirrors the README but adds extra context, limits, and setup notes so you can move from - install to first scan without guesswork. -

-
-
-
- -

Quick checklist

-
-
    -
  • - - Install the container and map /config + /media volumes. -
    • -
  • - - Enable integrations and add API keys where required. -
    • -
  • - - Scan a folder and review matches before applying. -
    • -
  • - - Use per-folder rules for language and formatting differences. -
    • -
-
-
- -
-
- -

Features

-
-

- Sublogue focuses on safe subtitle enrichment. It never shifts existing timecodes, and only inserts - content when there is a safe gap at the start or end of the file. -

-
-
-

Metadata injection

-

- Pull plot, runtime, ratings, and credits from OMDb, TMDb, TVmaze, or Wikipedia and insert them in a - clean, readable format. -

-
-
-

Safe timing

-

- Sublogue refuses to insert if there is not enough gap, so subtitle timing stays intact. -

-
-
-

Folder rules

-

- Override metadata source, language, and formatting per directory for mixed media libraries. -

-
-
-

Web UI

-

- Scan folders, batch process results, and track history from a lightweight Svelte UI. -

-
-
-
- -
-
- -

Integrations

-
-

- Each provider has a different signup and usage policy. Wikipedia is strict by design: exact title - matches with year validation are required to reduce false matches from an open encyclopedia. -

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ProviderSignup or API keyRate limitsNotes
OMDb - Get an API key - Free tier has a daily capBest for movie matching
TMDb - Request an API key - Per-second rate limitGreat for localization and posters
TVmaze - View API docs - Polite usage limitsNo API key required
Wikipedia - MediaWiki API - No hard limits, be politeStrict title matching
-
-
- -
-
- -

Screenshots

-
-

- The interface is designed for fast scans and quick metadata validation. These screenshots show the scan - results and settings panels. -

-
- Scan results - Settings panel -
-
- -
-
- -

Getting started

-
-

- Sublogue runs as a single container. Map /config for settings and /media for subtitles, then open the web - UI at http://localhost:5000. -

-
-
-

Docker Compose

-

- Create data/ and media/ folders next to your compose file. -

- 
version: "3.9"
-services:
-  sublogue:
-    image: ghcr.io/ponzischeme89/sublogue:latest
-    container_name: sublogue
-    restart: unless-stopped
-    environment:
-      - TZ=Pacific/Auckland
-    volumes:
-      - ./data:/config
-      - ./media:/media
-    ports:
-      - "5000:5000"
-
-
-

Unraid

-

- Use the bundled template and map host paths into /config and /media. -

-
-

/mnt/user/appdata/sublogue -> /config

-

/mnt/user/appdata/sublogue/media -> /media

-
-
-
-

Komodo

-

- Create a new stack and attach your external network. -

- 
version: "3.9"
-services:
-  sublogue:
-    image: ghcr.io/ponzischeme89/sublogue:latest
-    container_name: sublogue
-    ports:
-      - "5000:5000"
-    environment:
-      - TZ=Etc/UTC
-      - PUID=1000
-      - PGID=1000
-    volumes:
-      - /volume1/Docker/sublogue/data:/config
-      - /volume1/Media:/media
-    restart: unless-stopped
-    networks:
-      - npm_network
-networks:
-  npm_network:
-    external: true
-
-
-
- -
-
- -

Limitations

-
-
    -
  • API limits vary per provider and can throttle large scans.
    • -
  • Metadata gaps appear when providers do not have a title or plot.
    • -
  • Only TMDb supports localization. OMDb and TVmaze are English-first.
    • -
  • Long plots are inserted as-is. TVs may split them across screens.
    • -
  • Only .srt files are supported.
    • -
  • Reprocessing a file can insert multiple plot blocks.
    • -
-
- -
-
- -

Roadmap

-
-
    -
  • More UI themes and high contrast variants
    • -
  • Poster and backdrop previews in results
    • -
  • Duplicate plot detection and auto-avoidance
    • -
  • Automatic backoff and retry logic
    • -
  • Short plot mode for long summaries
    • -
  • Expanded localization for plots and cast
    • -
  • Subtitle format support beyond SRT
    • -
  • Optional local cache for metadata lookups
    • -
-
- -
-
-
- -

Support

-
-

- If Sublogue helps your library, consider starring the repo or sharing it with someone who cares about - clean subtitles. Bug reports and feature requests are welcome. -

-
-
-
- - -
- - - - - diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index f7e50ce..0000000 --- a/docs/index.html +++ /dev/null @@ -1,454 +0,0 @@ - - - - - - - Sublogue - - - - - - - - - - - -
-
-
-
- Sublogue -
-

Sublogue

-

Subtitle metadata orchestration

-
- -
- -
- Install - Integrations - Documentation - Quickstart -
-
-
- -
-
-
-

- Add metadata to your subtitles with Sublogue -

-

- Sublogue inserts story context into your subtitle files using OMDb, TMDb, and TVMaze. It can also - clean out ad blocks like YTS promo text while preserving timing, so every subtitle reads cleanly. -

-
- SRT safe - Multi-source - Batch scans - Web UI -
-
-
-
- -

Overview

-
-

- Sublogue scans your subtitle folders, pulls metadata from OMDb, TMDb, and TVMaze, then injects plots, - ratings, and credits directly into SRT files without touching timing. -

-
    -
  • - - Preserve original subtitle timing while enriching content. -
    • -
  • - - Remove ad text and promo lines from SRT files (YTS and similar). -
    • -
  • - - Choose preferred metadata sources per scan. -
    • -
  • - - Monitor integration usage and cache clearing in settings. -
    • -
-
-
- -
-
- -

Quickstart

-
-

- Launch the container, point Sublogue at your media folder, then open the UI and run a scan. -

-
-
-

Docker CLI

- 
docker run -d \
-  --name sublogue \
-  -p 5000:5000 \
-  -e TZ=Etc/UTC \
-  -e PUID=1000 -e PGID=1000 \
-  -v ./data:/config \
-  -v ./media:/media \
-  ponzischeme89/sublogue:latest
-
-
-

Open UI

-
- - http://localhost:5000 -
-

- Head to Settings -> Integrations to add your metadata providers and start scanning. -

-
-
-
- -
-
- -

Install

-
-
-
-

🐳 Docker Compose

-

- Ideal for Portainer, Synology, or homelab setups. -

- 
version: "3.9"
-services:
-  sublogue:
-    image: ponzischeme89/sublogue:latest
-    container_name: sublogue
-    restart: unless-stopped
-    environment:
-      - TZ=Etc/UTC
-      - PUID=1000
-      - PGID=1000
-    volumes:
-      - ./data:/config
-      - ./media:/media
-    ports:
-      - "5000:5000"
-
-
-

🧰 Unraid

-

- Use the bundled template and map volumes into /config and /media. -

-
-

/mnt/user/appdata/sublogue -> /config

-

/mnt/user/media -> /media

-
-
-
-

🐲 Komodo

-

- Paste a stack template and attach the NPM network. -

- 
version: "3.9"
-services:
-  sublogue:
-    image: ponzischeme89/sublogue:latest
-    container_name: sublogue
-    environment:
-      - TZ=Etc/UTC
-    ports:
-      - "5000:5000"
-    volumes:
-      - /volume1/Docker/sublogue/data:/config
-      - /volume1/Media:/media
-    restart: unless-stopped
-    networks:
-      - npm_network
-networks:
-  npm_network:
-    external: true
-
-
-
- -
-
- -

Clean SRTs

-
-

- Remove ad blocks like YTS and other promo lines without touching timing. Sublogue keeps subtitle order - intact while cleaning the text. -

-
-
-
-

Before

- - YTS - -
- 
1
-00:00:01,000 --> 00:00:04,000
-Visit YTS.mx for more movies
-
-2
-00:00:05,000 --> 00:00:07,200
-Grab the latest releases
-
-
-
-

After

- - Clean - -
- 
1
-00:00:08,000 --> 00:00:10,200
-You are early.
-

- Ad-only blocks are removed, while the rest of the subtitle content remains untouched. -

-
-
-
- -
-
- -

Metadata Examples

-
-

- Sublogue can insert plots, runtimes, directors, and ratings right into the subtitle header for quick - context before the dialogue begins. -

-
-
-
- -

Plot + Runtime

-
-
-

Injected Header

-

Plot

-

- A retired detective returns for one last case and uncovers a hidden network in the city. -

-

Runtime: 112 min

-
-
-
-
- -

Director + Cast

-
-
-

Injected Header

-

Director

-

Ava Solomon

-

Cast

-

J. Harper, L. Chen, M. Brooks

-
-
-
-
- -

Ratings

-
-
-

Injected Header

-
- - IMDb 7.8 - - - RT 94% - -
-
- - - - - -
-
-
- Sublogue - Sublogue metadata branding -
-
-
-
- -
-
-
- -

Integrations

-
-

- Start with zero providers enabled. Add OMDb, TMDb, or TVMaze when you have keys ready. Each scan can - choose its preferred source. -

-
-
-
- - OMDb - Fast movie metadata -
-
-
-
- - TMDb - Rich cast and ratings -
-
-
-
- - TVMaze - Series and episodes -
-
-
-
-
-
- -

API Notes

-
-

- Sublogue expects your media folders to be readable by the container. Large scans stream results to the - UI while the API continues processing in the background. -

-
-
- -
-

Volumes

-

Map /config for settings and /media for subtitle files.

-
-
-
- -
-

Status

-

Scan progress appears in the UI with streaming rows as files are processed.

-
-
-
- -
-

Settings

-

Integrations remain disabled until you add keys in the Settings tab.

-
-
-
-
-
- -
-
-
- -

Join the Community

-
-

- Jump into the ponzischeme89 Discord and visit #sublogue-support - for help, updates, and feature requests. -

-
- - #sublogue-support -
-
-
-
- - -
- - - - - diff --git a/docs/screenshots/screenshot_main.png b/docs/screenshots/screenshot_main.png deleted file mode 100644 index cd076cd..0000000 Binary files a/docs/screenshots/screenshot_main.png and /dev/null differ diff --git a/docs/screenshots/screenshot_scan.png b/docs/screenshots/screenshot_scan.png deleted file mode 100644 index 45d93d8..0000000 Binary files a/docs/screenshots/screenshot_scan.png and /dev/null differ diff --git a/docs/screenshots/screenshot_settings.png b/docs/screenshots/screenshot_settings.png deleted file mode 100644 index c64d6aa..0000000 Binary files a/docs/screenshots/screenshot_settings.png and /dev/null differ diff --git a/docs/sublogue_logo.png b/docs/sublogue_logo.png deleted file mode 100644 index 4e90ee4..0000000 Binary files a/docs/sublogue_logo.png and /dev/null differ diff --git a/docs/sublogue_v2.png b/docs/sublogue_v2.png deleted file mode 100644 index 4790c12..0000000 Binary files a/docs/sublogue_v2.png and /dev/null differ diff --git a/unraid-sublogue.xml b/unraid-sublogue.xml deleted file mode 100644 index 01a10f0..0000000 --- a/unraid-sublogue.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - sublogue - ponzischeme89/sublogue:latest - npm_network - - - bash - false - - - - - 5000 - 5000 - tcp - Web UI + API - - - - /mnt/user/appdata/sublogue - /config - rw - - - - /mnt/user/appdata/sublogue/media - /media - rw - - - - TZ - Etc/UTC - - - - PUID - 1000 - - - - PGID - 1000 - -