mirror of
https://github.com/unshackle-dl/unshackle.git
synced 2026-11-11 19:45:06 +00:00
imSp4rky
7fdd514e18
Persistent job history (capped by serve.history_limit, stored under cache), profiles/config reads, maintenance + env-check endpoints, and 409 conflict code.
unshackle Documentation
This is the canonical configuration reference for unshackle. unshackle/unshackle-example.yaml is a minimal starter config only - it intentionally omits most options. Come here for the full picture.
Contents
| Document | Description |
|---|---|
| Creating a Service | Section-by-section guide to writing a new service adapter, based on the EXAMPLE service |
| Advanced & System Configuration | serve, debugging, and system-level options not covered elsewhere |
| REST API Documentation | HTTP API exposed by unshackle serve: endpoints, auth, remote downloads, CDM hosting |
| Structured Debug Logging | -d/--debug JSONL output: schema, redaction rules, log_event/timed_operation conventions |
| Download & Processing Configuration | Downloader settings, concurrency, retries, and post-processing behaviour |
| DRM & CDM Configuration | Widevine, PlayReady, and ClearKey CDM setup; local and remote CDMs; key vaults |
| Gluetun VPN Proxy | Docker-managed VPN proxies via Gluetun; setup, WireGuard ready-detection |
| Network & Proxy Configuration | Proxy providers, geofence bypass, per-service proxy overrides |
| Output & Naming Configuration | Output directory layout, filename templates, folder naming |
| Service Integration & Authentication | Per-service config blocks, cookies, credentials, and metadata sources |
| Subtitle Processing Configuration | subtitle: key options: format conversion, styling, forced-sub rules |