imSp4rky
ebb4e74318
Supplied IDs resolve directly via a shared resolve_by_ids and never fall back to title search; metadata_providers gains per-kind ordering and a disable_metadata switch stops all automatic lookups while explicit IDs keep working. BREAKING: --tmdb/--imdb/--tvdb are now mutually exclusive and require a usable provider; --enrich also overwrites original language; the imdbapi provider and imdb_api_enabled are replaced by a keyless imdb provider.
2.5 KiB
Configuration Reference
Every key you can set in unshackle.yaml, with its name, type, default value, and behaviour,
split into one page per area. A worked config is on the annotated example page.
Where the file lives, how unshackle discovers it, and how to edit it: The Configuration File.
!!! info "How defaults work"
Every key is optional except output_template, which dl requires.
Without it, dl aborts with an error. If you omit any other key, unshackle uses
the built-in default listed here. There is no schema validation: unknown keys are
silently ignored (they never become settings), and the file is parsed with
yaml.safe_load. An empty or missing file means every other key falls back to its
default.
!!! warning "Two keys behave specially on load"
- curl_impersonate is a deprecated alias of network and emits a
DeprecationWarning.
- scene_naming has been removed. If it is set to any value, unshackle exits
immediately with an error telling you to use output_template
instead.
See [Deprecated & removed keys](misc.md#deprecated-removed-keys).
Quick index
| Area | Keys |
|---|---|
| Directories | directories, filenames |
| Services & authentication | services, credentials, firefox_cookies, remote_services, serve |
| Download & processing | dl, subtitle, audio, muxing, language_tags, dual_multi_mode |
| Output & naming | output_template, tag, tag_rules, tag_group_name, tag_imdb_tmdb, chapter_fallback_name, unicode_filenames |
| DRM & CDM | cdm, remote_cdm, decryption |
| Network & proxy | network, headers, proxy_providers |
| Key vaults | key_vaults, vault_timeout |
| External API keys | omdb_api_key, tmdb_api_key, tvdb_api_key, tvdb_pin, tvdb_order, simkl_client_id, metadata_providers, disable_metadata, decrypt_labs_api_key, ipinfo_api_key |
| Caching & updates | title_cache_enabled, title_cache_time, title_cache_max_retention, update_checks, update_check_interval |
| Logging, privacy & debug | redact_paths, debug, debug_keys, debug_requests, set_terminal_bg |
| Deprecated & removed | curl_impersonate, downloader, scene_naming |