peter
688efb9ed6
DX-10: the repo invited people to clone, build and self-host while carrying no LICENSE at all — which legally means all rights reserved, so none of that was permitted. Adds the verbatim GNU AGPL-3.0 text, the SPDX id in package.json and a README section. AGPL rather than MIT deliberately: this is a server application, so the case worth covering is someone running a modified copy as a network service. DX-12: .env.example documented PLEX_MEDIA_HOST_PATH -> /plex-media and the README advertised the Plex library, but only the localdev and home compose files carried the mount — on both PUBLIC files the module could read Plex's catalogue and then fail to open a single file, because it streams the media itself rather than proxying Plex. Both api and worker now mount it read-only with an empty named volume as the fallback, and self-hosting.md gains the section that explains the server URL/token, the path map and the mount together (it had never mentioned Plex). DX-15: the worker had no init: true on either public file, though localdev and home both carry tini with the reason written out — without PID 1 reaping, a watchdog hard-kill of a download's process group orphans its ffmpeg/yt-dlp grandchildren. Verified: 'compose config' resolves on both files, the Plex mount comes out read_only: true on api and worker, and init lands on worker (not just the bgutil-pot sidecar). Gate green: vitest 671, pytest 896.
100 lines
3.8 KiB
YAML
100 lines
3.8 KiB
YAML
services:
|
|
db:
|
|
image: postgres:16-alpine
|
|
environment:
|
|
POSTGRES_USER: ${POSTGRES_USER:-siftlode}
|
|
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-siftlode}
|
|
POSTGRES_DB: ${POSTGRES_DB:-siftlode}
|
|
volumes:
|
|
- pgdata:/var/lib/postgresql/data
|
|
healthcheck:
|
|
test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER:-siftlode} -d ${POSTGRES_DB:-siftlode}"]
|
|
interval: 5s
|
|
timeout: 5s
|
|
retries: 12
|
|
restart: unless-stopped
|
|
|
|
api:
|
|
build:
|
|
context: .
|
|
dockerfile: Dockerfile
|
|
args:
|
|
APP_VERSION: ${APP_VERSION:-dev}
|
|
GIT_SHA: ${GIT_SHA:-unknown}
|
|
BUILD_DATE: ${BUILD_DATE:-}
|
|
env_file: .env
|
|
environment:
|
|
DATABASE_URL: postgresql+psycopg://${POSTGRES_USER:-siftlode}:${POSTGRES_PASSWORD:-siftlode}@db:5432/${POSTGRES_DB:-siftlode}
|
|
# Download center: the API serves finished files + builds filmstrips; the worker (below) runs
|
|
# the yt-dlp job loop.
|
|
DOWNLOAD_ROOT: /downloads
|
|
WORKER_ENABLED: "false"
|
|
depends_on:
|
|
db:
|
|
condition: service_healthy
|
|
ports:
|
|
- "${APP_PORT:-8080}:8000"
|
|
volumes:
|
|
# Downloaded media. Defaults to a Docker-managed named volume; set DOWNLOAD_HOST_PATH in .env
|
|
# to a host directory (e.g. one your Plex server reads) to keep the Plex-style tree there.
|
|
- ${DOWNLOAD_HOST_PATH:-downloads}:/downloads
|
|
# Plex library, read-only. The Plex module streams files itself, so it needs to SEE them: set
|
|
# PLEX_MEDIA_HOST_PATH in .env to the host directory holding the library (the local side of the
|
|
# admin "path map", whose default is /data=/plex-media). Left unset it falls back to an empty
|
|
# named volume — harmless, and the Plex module is off by default.
|
|
- ${PLEX_MEDIA_HOST_PATH:-plex_media}:/plex-media:ro
|
|
healthcheck:
|
|
test: ["CMD", "python", "-c", "import urllib.request; exit(0 if urllib.request.urlopen('http://localhost:8000/healthz').status == 200 else 1)"]
|
|
interval: 15s
|
|
timeout: 5s
|
|
retries: 5
|
|
start_period: 25s
|
|
restart: unless-stopped
|
|
|
|
# Download worker: same image, runs the yt-dlp / ffmpeg job loop instead of the API. Shares the
|
|
# DB (job queue) + the downloads mount with the API.
|
|
worker:
|
|
build:
|
|
context: .
|
|
dockerfile: Dockerfile
|
|
args:
|
|
APP_VERSION: ${APP_VERSION:-dev}
|
|
GIT_SHA: ${GIT_SHA:-unknown}
|
|
BUILD_DATE: ${BUILD_DATE:-}
|
|
command: ["python", "-m", "app.worker"]
|
|
# tini as PID 1: reaps orphaned ffmpeg/yt-dlp grandchildren when the watchdog hard-kills a
|
|
# download child's process group (the worker reaps its own direct children via subprocess.wait).
|
|
init: true
|
|
env_file: .env
|
|
environment:
|
|
DATABASE_URL: postgresql+psycopg://${POSTGRES_USER:-siftlode}:${POSTGRES_PASSWORD:-siftlode}@db:5432/${POSTGRES_DB:-siftlode}
|
|
SCHEDULER_ENABLED: "false"
|
|
DOWNLOAD_ROOT: /downloads
|
|
WORKER_ENABLED: "true"
|
|
depends_on:
|
|
db:
|
|
condition: service_healthy
|
|
# Start only after the API is healthy (it applies the DB migrations on startup).
|
|
api:
|
|
condition: service_healthy
|
|
bgutil-pot:
|
|
condition: service_started
|
|
volumes:
|
|
- ${DOWNLOAD_HOST_PATH:-downloads}:/downloads
|
|
# Same read-only Plex library as the API — the worker resolves library paths too.
|
|
- ${PLEX_MEDIA_HOST_PATH:-plex_media}:/plex-media:ro
|
|
restart: unless-stopped
|
|
|
|
# PO-token provider sidecar: mints YouTube Proof-of-Origin tokens so the worker beats bot-detection
|
|
# and unlocks high-quality formats (reached at http://bgutil-pot:4416, the config default).
|
|
bgutil-pot:
|
|
image: brainicism/bgutil-ytdlp-pot-provider:1.3.1
|
|
init: true
|
|
restart: unless-stopped
|
|
|
|
volumes:
|
|
pgdata:
|
|
downloads:
|
|
# Empty fallback for the Plex media mount when PLEX_MEDIA_HOST_PATH is unset (Plex module off).
|
|
plex_media:
|