Files
unshackle/unshackle/unshackle-example.yaml
T
2026-08-19 13:45:58 -06:00

65 lines
3.0 KiB
YAML

# unshackle configuration (copy to unshackle.yaml)
#
# This is a MINIMAL starter. Every option has a sane default, so unshackle runs
# even with most of this file empty or removed.
#
# The full, canonical configuration reference lives in docs/. Start at
# docs/README.md. Each section below points to the doc that documents it.
# Group or username appended to download filenames after a dash.
tag: "NOGRP"
# Conditionally swap the tag above based on filename variables (first match wins).
# See docs/reference/configuration.md#tag_rules for conditions and semantics.
# tag_rules:
# - when: {lang_tag: SUBBED}
# tag: SUBGRP
# --- Output filename & folder templates --- docs/guide/output-and-naming.md
# The full variable list and all naming options are documented there.
# movies/series have no built-in fallback (define them to download those kinds);
# songs falls back to "{track_number}. {title}". Conditional variables take a
# ? suffix, e.g. {year?}.
output_template:
# Scene-style naming (dot-separated)
movies: "{title}.{year?}.{repack?}.{edition?}.{lang_tag?}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{dubbed?}.{audio_full}.{atmos?}.{hdr?}.{hfr?}.{video}-{tag}"
series: "{title}.{year?}.{season_episode}.{episode_name?}.{repack?}.{edition?}.{lang_tag?}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{dubbed?}.{audio_full}.{atmos?}.{hdr?}.{hfr?}.{video}-{tag}"
songs: "{track_number}.{title}.{repack?}.{edition?}.{lang_tag?}.{source?}.WEB-DL.{audio_full}.{atmos?}-{tag}"
folder:
movies: "{title}.{year?}.{repack?}.{edition?}.{lang_tag?}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{dubbed?}.{audio_full}.{atmos?}.{hdr?}.{hfr?}.{video}-{tag}"
series: "{title}.{year?}.{repack?}.{edition?}.{lang_tag?}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{dubbed?}.{audio_full}.{atmos?}.{hdr?}.{hfr?}.{video}-{tag}"
albums: "{album_artist} - {album} ({year?})"
#
# Plex-friendly alternatives:
# movies: '{title} ({year}) {quality}'
# series: '{title} {season_episode} {episode_name?}'
# songs: '{track_number}. {title}'
#
# Folder naming (optional). One template for all, or a per-kind map.
# Valid kinds: movies, series, songs, albums (album vars: see docs).
# folder: '{title} ({year?})'
# folder:
# movies: '{title} ({year})'
# series: '{title} ({year?})'
# albums: '{album_artist} - {album} ({year?})'
# --- DRM / CDM --- docs/DRM_CONFIG.md
# Which Widevine (.wvd) or PlayReady (.prd) device to use. 'default' is the
# global fallback. Per-service, per-profile, quality-based selection and remote
# CDMs are all documented in docs/DRM_CONFIG.md.
cdm:
default: WVD_1
# --- Key vaults --- docs/DRM_CONFIG.md
# Where obtained Content Encryption Keys (CEKs) are stored and retrieved.
key_vaults:
- type: SQLite
name: Local
path: key_store.db
# --- Everything else lives in docs/ ---
# credentials, directories, proxy providers, subtitles, muxing, serve/REST API,
# remote services, per-service overrides, debug logging, Firefox cookie import,
# and more. See docs/README.md for the full index.