--- icon: material/docker hide: - tags tags: - lidarr saltbox_automation: app_links: - name: Manual url: type: documentation - name: Releases url: https://github.com/hotio/lidarr/pkgs/container/lidarr type: github - name: Community url: https://hotio.dev/discord type: discord project_description: name: Lidarr summary: |- a music collection manager designed for Usenet and BitTorrent users, automating the process of finding, downloading, and managing albums and tracks. link: https://lidarr.audio --- # Lidarr ## Overview [Lidarr](https://lidarr.audio) is a music collection manager designed for Usenet and BitTorrent users, automating the process of finding, downloading, and managing albums and tracks.
[:fontawesome-solid-book-open:**Manual**](){ .md-button .md-button--stretch } [:fontawesome-brands-github:**Releases**](https://github.com/hotio/lidarr/pkgs/container/lidarr){ .md-button .md-button--stretch } [:fontawesome-brands-discord:**Community**](https://hotio.dev/discord){ .md-button .md-button--stretch }
--- ## Deployment ```shell sb install lidarr ``` ## Usage Visit . ## Basics ### Settings Click on "Settings" in the sidebar. Click "Show Advanced" at the top of the Settings pane. Make changes in the following sections: !!! info "Settings" === "Media Management" These settings control management of media files. === "Movie Naming" - "Rename Tracks": `Yes` - "Replace Illegal Characters": `Yes` - Set your preferred naming format; here are some examples.
Plex's Naming Preference
Example:
``` 01 - Shine On You Crazy Diamond (Parts I-V).m4a ``` Standard Track Format:
``` {track:00} - {Track Title} ``` Artist Folder Format:
``` {Artist Name} ``` Album Folder Format:
``` {Artist Name} - {Album Title} ``` Reference: https://support.plex.tv/articles/categories/media-preparation/naming-and-organizing-music-media/
=== "Folders" - "Create empty artist folders": `No` - "Delete empty folders": `No` === "Importing" - "Skip Free Space Check": `No` - "Minimum Free Space": `100` (_can be your preference so long as you use a reasonable value_) - "Use Hardlinks instead of Copy": `Yes` - "Import Extra Files": `Yes` (_can be your preference_) - "Extra File Extensions": `srt` (_can be your preference_) === "File Management" - "Ignore Deleted Tracks": `No` (_can be your preference_) - "Propers and Repacks": `Prefer and Upgrade` (_can be your preference_) - "Watch Root Folders for file changes": 'Yes' - "Rescan Artist Folder after Refresh": `Never` - "Allow Fingerprinting": `For new imports only` - "Change File Date": `Album Release Date` (_can be your preference_) - "Recycle Bin": _blank_ (Rclone deletes are sent to Gdrive trash folder, anyway) - "Recycling Bin Cleanup": '0' === "Permissions" - Set Permissions: `No` === "Save" - Click "Save". === "Indexers" These settings control [indexers](../saltbox/prerequisites/prerequisites.md#usenet-or-bittorrent-sources) and related behavior. === "NZBHydra2" 1. Click Add Indexer (`+`). 2. Select "Newznab". 3. Add the following: Name: NZBHydra2 Enable RSS Sync: _Your Preference_ Enable Automatic Search: _Your Preference_ Enable Interactive Search: _Your Preference_ URL: `http://nzbhydra2:5076` API Key: [Your NZBHydra2 API Key](../apps/nzbhydra2.md) Early Download Limit: _Your Preference_ Additional Parameters: _Leave Blank_ 4. Your settings will look like this: ![Lidarr NZBHydra2](../images/lidarr/lidarr-nzbhydra.png) 5. Click "Save" to add NZBHydra2. Note: The "Test" will keep failing until you add an indexer in [NZBHydra2](../apps/nzbhydra2.md). === "Jackett" Note: Each Indexer you have defined in Jackett will need to be added separately. 1. Click Add Indexer (`+`) 2. Select "Torznab". 3. Add the following: Name: Indexer Name Enable RSS Sync: _Your Preference_ Enable Automatic Search: _Your Preference_ Enable Interactive Search: _Your Preference_ URL: [Indexer's Torznab Feed](../apps/jackett.md) API Key: [Your Jackett API Key](../apps/jackett.md) Early Download Limit: _Your Preference_ Additional Parameters: _Leave Blank_ 4. Your settings will look like this: ![Lidarr Jackett](../images/lidarr/lidarr-jackett.png) 5. Click "Save" to add the indexer. === "Download Clients" These settings control downloading behavior and clients. === "Completed Download Handling" - "Enable": `Yes` - "Remove": `Yes` (_can be your preference_) === "Failed Download Handling" - "Redownload": `Yes` - "Remove": `Yes` === "NZBGet" 1. Click Add (`+`) 2. Add a new "NZBGet" download client. 3. Add the following: Name: NZBGet Enable: `Yes` Host: `nzbget` Port: `6789` Username: [Your NZBGet Username](../apps/nzbget.md) Password: [Your NZBGet Password](../apps/nzbget.md) Category: `lidarr` Use SSL: `No` Add Paused: `No` 4. Your settings will look like this: ![Lidarr NZBGet Downloader](../images/lidarr/01-lidarr-nzbget.png) 5. Click "Save" to add NZBGet. === "ruTorrent" 1. Click Add (`+`) 2. Add a new "rTorrent" download client. 3. Add the following: Name: ruTorrent Enable: `Yes` Host: `rutorrent` Port: `80` URL Path: `RPC2` Use SSL: `No` Username: [Your ruTorrent Username](../sandbox/apps/rutorrent.md) Password: [Your ruTorrent Password](../sandbox/apps/rutorrent.md) Category: `lidarr` Directory: _Leave Blank_ 4. Your settings will now look like this: ![Radarr ruTorrent Downloader](../images/lidarr/lidarr-rtorrent.png) 5. Click "Save" to add ruTorrent. === "qBittorrent" 1. Click Add ('+') 2. Add a new "qBittorrent" download client. 3. Add the following: Name: qBittorrent Enable: 'Yes' Host: 'qBittorrent' Port: '8080' Username: [Your qBittorrent Username](../apps/qbittorrent.md) Password: [Your qBittorrent Password](../apps/qbittorrent.md) Category: 'lidarr' 4. Your settings will now look like this: ![Lidarr qBittorent Downloader](../images/lidarr/lidarr-qbittorrent.png) 5. Click "Save" to add qBittorrent qb === "Connect" These settings control connections to other applications or systems. === "Torrent Cleanup" Torrent Cleanup Script is a custom script that will clean up torrents from ruTorrent that were auto-extracted, but still being seeded. So if the script detects that `.rar` files are in the folder that Radarr just imported from, it will delete the imported audio file(s), leaving just the `.rar` files for seeding. 1. Click "Settings" -> "Connect". 2. Add a new "Custom Script". 3. Add the following: Name: Torrent Cleanup On Grab: `No` On Release Import: `Yes` On Upgrade: `Yes` On Rename:`No` Path: `/scripts/torrents/TorrentCleanup.py` 4. The settings will look like this: ![Lidarr Torrent Cleanup Script CloudBox](../images/lidarr/lidarr-torrentcleanup.png) 5. Click "Save" to add the Torrent Cleanup script. === "Autoscan" 1. Click "Settings" -> "Connect". 2. Add a new "Webhook". 3. Add the following: Name: Autoscan On Grab: `No` On Release Import: `Yes` On Upgrade: `Yes` On Rename: `Yes` On Track Retag: `No` On Health Issue: `No` Tags: _Leave Blank_ URL: `http://autoscan:3030/triggers/lidarr` Method:`POST` Username: AS SET IN AUTOSCAN CONFIG (defaults to Saltbox Username) Password: AS SET IN AUTOSCAN CONFIG (defaults to Saltbox Password) 4. The settings will look like this: ![lidarr Autoscan](../images/lidarr/lidarr-autoscan.png) 5. Click "Save" to add Autoscan. === "General" These settings control general aspects of Radarr. === "Start-Up" - "Bind Address: `*` - "Port Number": `8686` - "URL Base": _blank_ - "Enable SSL": `No` (_SSL is handled by Traefik_) - "Open browser on start": `No` === "Proxy Settings" - "Use Proxy": `No` === "Logging" - "Log Level": `Debug` === "Analytics" - "Send Anonymous Usage Data": `No` (_your preference_) === "Updates" - "Branch": `develop` - "Automatic": `Off` === "Save" - Click "Save". ### Music Path 1. When you are ready to add your first artist to Lidarr, click the "Path" drop-down and select "Add a different path". 1. Click the blue "Browse" button, navigate to `/mnt/unionfs/Media/Music`, scroll to the bottom, and select "OK". 1. Click the green "check" button to add the path. 1. All artists added now will have that path set. ### API Key This is used during the setup of [Organizr](organizr.md). - Go to "Settings" -> "General" -> "Security" -> "API Key". ## Next
Are you setting Saltbox up for the first time?
[**Continue to Seerr**:material-forward:](seerr.md){ .md-button }
## Role Defaults Variables can be customized using the [Inventory](/saltbox/inventory/index.md#overriding-variables){ data-preview }. (1) { .annotate .sb-annotated } 1. **This role supports multiple instances via `lidarr_instances`.** !!! example "Example override" === "Role-scoped" ```yaml lidarr_role_web_subdomain: "custom" ``` :material-arrow-right-bottom-bold: Applies to all instances of lidarr === "Instance-scoped" ```yaml lidarr2_web_subdomain: "custom2" ``` :material-arrow-right-bottom-bold: Applies to the instance named lidarr2 !!! warning "Avoid overriding variables ending in `_default`" When overriding variables that end in `_default` (like `lidarr_docker_envs_default`), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality. Instead, use the corresponding `_custom` variable (like `lidarr_docker_envs_custom`) to add your changes. Custom values are merged with defaults, ensuring you receive updates. === "Basics" ??? variable list "`lidarr_instances`" ```yaml # Type: list lidarr_instances: ["lidarr"] ``` !!! example "Example Override" ```yaml # Type: list lidarr_instances: ["lidarr", "lidarr2"] ``` === "Settings" ??? variable bool "`lidarr_role_external_auth`{ .sb-show-on-unchecked }`lidarr2_external_auth`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_external_auth: true ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_external_auth: true ``` === "Web" ??? variable string "`lidarr_role_web_subdomain`{ .sb-show-on-unchecked }`lidarr2_web_subdomain`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_web_subdomain: "{{ lidarr_name }}" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_web_subdomain: "{{ lidarr_name }}" ``` ??? variable string "`lidarr_role_web_domain`{ .sb-show-on-unchecked }`lidarr2_web_domain`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_web_domain: "{{ user.domain }}" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_web_domain: "{{ user.domain }}" ``` ??? variable string "`lidarr_role_web_port`{ .sb-show-on-unchecked }`lidarr2_web_port`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_web_port: "8686" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_web_port: "8686" ``` ??? variable string "`lidarr_role_web_url`{ .sb-show-on-unchecked }`lidarr2_web_url`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='lidarr') + '.' + lookup('role_var', '_web_domain', role='lidarr') if (lookup('role_var', '_web_subdomain', role='lidarr') | length > 0) else lookup('role_var', '_web_domain', role='lidarr')) }}" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='lidarr') + '.' + lookup('role_var', '_web_domain', role='lidarr') if (lookup('role_var', '_web_subdomain', role='lidarr') | length > 0) else lookup('role_var', '_web_domain', role='lidarr')) }}" ``` === "DNS" ??? variable string "`lidarr_role_dns_record`{ .sb-show-on-unchecked }`lidarr2_dns_record`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='lidarr') }}" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_dns_record: "{{ lookup('role_var', '_web_subdomain', role='lidarr') }}" ``` ??? variable string "`lidarr_role_dns_zone`{ .sb-show-on-unchecked }`lidarr2_dns_zone`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='lidarr') }}" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_dns_zone: "{{ lookup('role_var', '_web_domain', role='lidarr') }}" ``` ??? variable bool "`lidarr_role_dns_proxy`{ .sb-show-on-unchecked }`lidarr2_dns_proxy`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_dns_proxy: "{{ dns_proxied }}" ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_dns_proxy: "{{ dns_proxied }}" ``` === "Traefik" ??? variable string "`lidarr_role_traefik_sso_middleware`{ .sb-show-on-unchecked }`lidarr2_traefik_sso_middleware`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}" ``` ??? variable string "`lidarr_role_traefik_middleware_default`{ .sb-show-on-unchecked }`lidarr2_traefik_middleware_default`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_traefik_middleware_default: "{{ traefik_default_middleware + (',themepark-' + lidarr_name if (lookup('role_var', '_themepark_enabled', role='lidarr') and global_themepark_plugin_enabled) else '') }}" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_traefik_middleware_default: "{{ traefik_default_middleware + (',themepark-' + lidarr_name if (lookup('role_var', '_themepark_enabled', role='lidarr') and global_themepark_plugin_enabled) else '') }}" ``` ??? variable string "`lidarr_role_traefik_middleware_custom`{ .sb-show-on-unchecked }`lidarr2_traefik_middleware_custom`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_traefik_middleware_custom: "" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_traefik_middleware_custom: "" ``` ??? variable string "`lidarr_role_traefik_certresolver`{ .sb-show-on-unchecked }`lidarr2_traefik_certresolver`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_traefik_certresolver: "{{ traefik_default_certresolver }}" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_traefik_certresolver: "{{ traefik_default_certresolver }}" ``` ??? variable bool "`lidarr_role_traefik_enabled`{ .sb-show-on-unchecked }`lidarr2_traefik_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_traefik_enabled: true ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_traefik_enabled: true ``` ??? variable bool "`lidarr_role_traefik_api_enabled`{ .sb-show-on-unchecked }`lidarr2_traefik_api_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_traefik_api_enabled: true ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_traefik_api_enabled: true ``` ??? variable string "`lidarr_role_traefik_api_endpoint`{ .sb-show-on-unchecked }`lidarr2_traefik_api_endpoint`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_traefik_api_endpoint: "PathPrefix(`/api`) || PathPrefix(`/feed`) || PathPrefix(`/ping`)" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_traefik_api_endpoint: "PathPrefix(`/api`) || PathPrefix(`/feed`) || PathPrefix(`/ping`)" ``` === "Theme" ??? variable bool "`lidarr_role_themepark_enabled`{ .sb-show-on-unchecked }`lidarr2_themepark_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Options can be found at https://github.com/themepark-dev/theme.park # Type: bool (true/false) lidarr_role_themepark_enabled: false ``` ```yaml { .sb-show-on-checked } # Options can be found at https://github.com/themepark-dev/theme.park # Type: bool (true/false) lidarr2_themepark_enabled: false ``` ??? variable string "`lidarr_role_themepark_app`{ .sb-show-on-unchecked }`lidarr2_themepark_app`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_themepark_app: "lidarr" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_themepark_app: "lidarr" ``` ??? variable string "`lidarr_role_themepark_theme`{ .sb-show-on-unchecked }`lidarr2_themepark_theme`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_themepark_theme: "{{ global_themepark_theme }}" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_themepark_theme: "{{ global_themepark_theme }}" ``` ??? variable string "`lidarr_role_themepark_domain`{ .sb-show-on-unchecked }`lidarr2_themepark_domain`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_themepark_domain: "{{ global_themepark_domain }}" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_themepark_domain: "{{ global_themepark_domain }}" ``` ??? variable list "`lidarr_role_themepark_addons`{ .sb-show-on-unchecked }`lidarr2_themepark_addons`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_themepark_addons: [] ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_themepark_addons: [] ``` === "Docker"
Container
??? variable string "`lidarr_role_docker_container`{ .sb-show-on-unchecked }`lidarr2_docker_container`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_container: "{{ lidarr_name }}" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_container: "{{ lidarr_name }}" ```
Image
??? variable bool "`lidarr_role_docker_image_pull`{ .sb-show-on-unchecked }`lidarr2_docker_image_pull`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_image_pull: true ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_image_pull: true ``` ??? variable string "`lidarr_role_docker_image_repo`{ .sb-show-on-unchecked }`lidarr2_docker_image_repo`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_image_repo: "ghcr.io/hotio/lidarr" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_image_repo: "ghcr.io/hotio/lidarr" ``` ??? variable string "`lidarr_role_docker_image_tag`{ .sb-show-on-unchecked }`lidarr2_docker_image_tag`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_image_tag: "release" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_image_tag: "release" ``` ??? variable string "`lidarr_role_docker_image`{ .sb-show-on-unchecked }`lidarr2_docker_image`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='lidarr') }}:{{ lookup('role_var', '_docker_image_tag', role='lidarr') }}" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='lidarr') }}:{{ lookup('role_var', '_docker_image_tag', role='lidarr') }}" ```
Envs
??? variable dict "`lidarr_role_docker_envs_default`{ .sb-show-on-unchecked }`lidarr2_docker_envs_default`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict lidarr_role_docker_envs_default: PUID: "{{ uid }}" PGID: "{{ gid }}" UMASK: "002" TZ: "{{ tz }}" ``` ```yaml { .sb-show-on-checked } # Type: dict lidarr2_docker_envs_default: PUID: "{{ uid }}" PGID: "{{ gid }}" UMASK: "002" TZ: "{{ tz }}" ``` ??? variable dict "`lidarr_role_docker_envs_custom`{ .sb-show-on-unchecked }`lidarr2_docker_envs_custom`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict lidarr_role_docker_envs_custom: {} ``` ```yaml { .sb-show-on-checked } # Type: dict lidarr2_docker_envs_custom: {} ```
Volumes
??? variable list "`lidarr_role_docker_volumes_default`{ .sb-show-on-unchecked }`lidarr2_docker_volumes_default`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_volumes_default: - "{{ lidarr_role_paths_location }}:/config" - "{{ server_appdata_path }}/scripts:/scripts" ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_volumes_default: - "{{ lidarr_role_paths_location }}:/config" - "{{ server_appdata_path }}/scripts:/scripts" ``` ??? variable list "`lidarr_role_docker_volumes_legacy`{ .sb-show-on-unchecked }`lidarr2_docker_volumes_legacy`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_volumes_legacy: - "/mnt/unionfs/Media/Music:/music" ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_volumes_legacy: - "/mnt/unionfs/Media/Music:/music" ``` ??? variable list "`lidarr_role_docker_volumes_custom`{ .sb-show-on-unchecked }`lidarr2_docker_volumes_custom`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_volumes_custom: [] ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_volumes_custom: [] ```
Labels
??? variable dict "`lidarr_role_docker_labels_default`{ .sb-show-on-unchecked }`lidarr2_docker_labels_default`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict lidarr_role_docker_labels_default: {} ``` ```yaml { .sb-show-on-checked } # Type: dict lidarr2_docker_labels_default: {} ``` ??? variable dict "`lidarr_role_docker_labels_custom`{ .sb-show-on-unchecked }`lidarr2_docker_labels_custom`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict lidarr_role_docker_labels_custom: {} ``` ```yaml { .sb-show-on-checked } # Type: dict lidarr2_docker_labels_custom: {} ```
Hostname
??? variable string "`lidarr_role_docker_hostname`{ .sb-show-on-unchecked }`lidarr2_docker_hostname`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_hostname: "{{ lidarr_name }}" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_hostname: "{{ lidarr_name }}" ```
Networks
??? variable string "`lidarr_role_docker_networks_alias`{ .sb-show-on-unchecked }`lidarr2_docker_networks_alias`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_networks_alias: "{{ lidarr_name }}" ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_networks_alias: "{{ lidarr_name }}" ``` ??? variable list "`lidarr_role_docker_networks_default`{ .sb-show-on-unchecked }`lidarr2_docker_networks_default`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_networks_default: [] ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_networks_default: [] ``` ??? variable list "`lidarr_role_docker_networks_custom`{ .sb-show-on-unchecked }`lidarr2_docker_networks_custom`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_networks_custom: [] ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_networks_custom: [] ```
Restart Policy
??? variable string "`lidarr_role_docker_restart_policy`{ .sb-show-on-unchecked }`lidarr2_docker_restart_policy`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_restart_policy: unless-stopped ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_restart_policy: unless-stopped ```
State
??? variable string "`lidarr_role_docker_state`{ .sb-show-on-unchecked }`lidarr2_docker_state`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_state: started ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_state: started ``` === "Docker+" The following advanced options are available via create_docker_container but are not defined in the role. See: [docker_container module](https://docs.ansible.com/ansible/latest/collections/community/docker/docker_container_module.html)
Resource Limits
??? variable int "`lidarr_role_docker_blkio_weight`{ .sb-show-on-unchecked }`lidarr2_docker_blkio_weight`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int lidarr_role_docker_blkio_weight: ``` ```yaml { .sb-show-on-checked } # Type: int lidarr2_docker_blkio_weight: ``` ??? variable int "`lidarr_role_docker_cpu_period`{ .sb-show-on-unchecked }`lidarr2_docker_cpu_period`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int lidarr_role_docker_cpu_period: ``` ```yaml { .sb-show-on-checked } # Type: int lidarr2_docker_cpu_period: ``` ??? variable int "`lidarr_role_docker_cpu_quota`{ .sb-show-on-unchecked }`lidarr2_docker_cpu_quota`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int lidarr_role_docker_cpu_quota: ``` ```yaml { .sb-show-on-checked } # Type: int lidarr2_docker_cpu_quota: ``` ??? variable int "`lidarr_role_docker_cpu_shares`{ .sb-show-on-unchecked }`lidarr2_docker_cpu_shares`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int lidarr_role_docker_cpu_shares: ``` ```yaml { .sb-show-on-checked } # Type: int lidarr2_docker_cpu_shares: ``` ??? variable string "`lidarr_role_docker_cpus`{ .sb-show-on-unchecked }`lidarr2_docker_cpus`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_cpus: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_cpus: ``` ??? variable string "`lidarr_role_docker_cpuset_cpus`{ .sb-show-on-unchecked }`lidarr2_docker_cpuset_cpus`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_cpuset_cpus: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_cpuset_cpus: ``` ??? variable string "`lidarr_role_docker_cpuset_mems`{ .sb-show-on-unchecked }`lidarr2_docker_cpuset_mems`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_cpuset_mems: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_cpuset_mems: ``` ??? variable string "`lidarr_role_docker_kernel_memory`{ .sb-show-on-unchecked }`lidarr2_docker_kernel_memory`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_kernel_memory: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_kernel_memory: ``` ??? variable string "`lidarr_role_docker_memory`{ .sb-show-on-unchecked }`lidarr2_docker_memory`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_memory: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_memory: ``` ??? variable string "`lidarr_role_docker_memory_reservation`{ .sb-show-on-unchecked }`lidarr2_docker_memory_reservation`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_memory_reservation: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_memory_reservation: ``` ??? variable string "`lidarr_role_docker_memory_swap`{ .sb-show-on-unchecked }`lidarr2_docker_memory_swap`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_memory_swap: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_memory_swap: ``` ??? variable int "`lidarr_role_docker_memory_swappiness`{ .sb-show-on-unchecked }`lidarr2_docker_memory_swappiness`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int lidarr_role_docker_memory_swappiness: ``` ```yaml { .sb-show-on-checked } # Type: int lidarr2_docker_memory_swappiness: ``` ??? variable string "`lidarr_role_docker_shm_size`{ .sb-show-on-unchecked }`lidarr2_docker_shm_size`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_shm_size: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_shm_size: ```
Security & Devices
??? variable list "`lidarr_role_docker_cap_drop`{ .sb-show-on-unchecked }`lidarr2_docker_cap_drop`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_cap_drop: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_cap_drop: ``` ??? variable string "`lidarr_role_docker_cgroupns_mode`{ .sb-show-on-unchecked }`lidarr2_docker_cgroupns_mode`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_cgroupns_mode: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_cgroupns_mode: ``` ??? variable list "`lidarr_role_docker_device_cgroup_rules`{ .sb-show-on-unchecked }`lidarr2_docker_device_cgroup_rules`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_device_cgroup_rules: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_device_cgroup_rules: ``` ??? variable list "`lidarr_role_docker_device_read_bps`{ .sb-show-on-unchecked }`lidarr2_docker_device_read_bps`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_device_read_bps: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_device_read_bps: ``` ??? variable list "`lidarr_role_docker_device_read_iops`{ .sb-show-on-unchecked }`lidarr2_docker_device_read_iops`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_device_read_iops: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_device_read_iops: ``` ??? variable list "`lidarr_role_docker_device_requests`{ .sb-show-on-unchecked }`lidarr2_docker_device_requests`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_device_requests: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_device_requests: ``` ??? variable list "`lidarr_role_docker_device_write_bps`{ .sb-show-on-unchecked }`lidarr2_docker_device_write_bps`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_device_write_bps: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_device_write_bps: ``` ??? variable list "`lidarr_role_docker_device_write_iops`{ .sb-show-on-unchecked }`lidarr2_docker_device_write_iops`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_device_write_iops: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_device_write_iops: ``` ??? variable list "`lidarr_role_docker_devices`{ .sb-show-on-unchecked }`lidarr2_docker_devices`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_devices: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_devices: ``` ??? variable list "`lidarr_role_docker_groups`{ .sb-show-on-unchecked }`lidarr2_docker_groups`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_groups: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_groups: ``` ??? variable bool "`lidarr_role_docker_privileged`{ .sb-show-on-unchecked }`lidarr2_docker_privileged`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_privileged: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_privileged: ``` ??? variable list "`lidarr_role_docker_security_opts`{ .sb-show-on-unchecked }`lidarr2_docker_security_opts`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_security_opts: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_security_opts: ``` ??? variable string "`lidarr_role_docker_user`{ .sb-show-on-unchecked }`lidarr2_docker_user`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_user: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_user: ``` ??? variable string "`lidarr_role_docker_userns_mode`{ .sb-show-on-unchecked }`lidarr2_docker_userns_mode`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_userns_mode: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_userns_mode: ```
Networking
??? variable list "`lidarr_role_docker_dns_opts`{ .sb-show-on-unchecked }`lidarr2_docker_dns_opts`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_dns_opts: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_dns_opts: ``` ??? variable list "`lidarr_role_docker_dns_search_domains`{ .sb-show-on-unchecked }`lidarr2_docker_dns_search_domains`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_dns_search_domains: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_dns_search_domains: ``` ??? variable list "`lidarr_role_docker_dns_servers`{ .sb-show-on-unchecked }`lidarr2_docker_dns_servers`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_dns_servers: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_dns_servers: ``` ??? variable string "`lidarr_role_docker_domainname`{ .sb-show-on-unchecked }`lidarr2_docker_domainname`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_domainname: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_domainname: ``` ??? variable list "`lidarr_role_docker_exposed_ports`{ .sb-show-on-unchecked }`lidarr2_docker_exposed_ports`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_exposed_ports: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_exposed_ports: ``` ??? variable dict "`lidarr_role_docker_hosts`{ .sb-show-on-unchecked }`lidarr2_docker_hosts`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict lidarr_role_docker_hosts: ``` ```yaml { .sb-show-on-checked } # Type: dict lidarr2_docker_hosts: ``` ??? variable bool "`lidarr_role_docker_hosts_use_common`{ .sb-show-on-unchecked }`lidarr2_docker_hosts_use_common`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_hosts_use_common: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_hosts_use_common: ``` ??? variable string "`lidarr_role_docker_ipc_mode`{ .sb-show-on-unchecked }`lidarr2_docker_ipc_mode`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_ipc_mode: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_ipc_mode: ``` ??? variable list "`lidarr_role_docker_links`{ .sb-show-on-unchecked }`lidarr2_docker_links`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_links: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_links: ``` ??? variable string "`lidarr_role_docker_network_mode`{ .sb-show-on-unchecked }`lidarr2_docker_network_mode`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_network_mode: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_network_mode: ``` ??? variable string "`lidarr_role_docker_pid_mode`{ .sb-show-on-unchecked }`lidarr2_docker_pid_mode`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_pid_mode: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_pid_mode: ``` ??? variable list "`lidarr_role_docker_ports`{ .sb-show-on-unchecked }`lidarr2_docker_ports`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_ports: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_ports: ``` ??? variable string "`lidarr_role_docker_uts`{ .sb-show-on-unchecked }`lidarr2_docker_uts`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_uts: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_uts: ```
Storage
??? variable bool "`lidarr_role_docker_keep_volumes`{ .sb-show-on-unchecked }`lidarr2_docker_keep_volumes`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_keep_volumes: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_keep_volumes: ``` ??? variable list "`lidarr_role_docker_mounts`{ .sb-show-on-unchecked }`lidarr2_docker_mounts`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_mounts: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_mounts: ``` ??? variable dict "`lidarr_role_docker_storage_opts`{ .sb-show-on-unchecked }`lidarr2_docker_storage_opts`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict lidarr_role_docker_storage_opts: ``` ```yaml { .sb-show-on-checked } # Type: dict lidarr2_docker_storage_opts: ``` ??? variable list "`lidarr_role_docker_tmpfs`{ .sb-show-on-unchecked }`lidarr2_docker_tmpfs`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_tmpfs: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_tmpfs: ``` ??? variable string "`lidarr_role_docker_volume_driver`{ .sb-show-on-unchecked }`lidarr2_docker_volume_driver`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_volume_driver: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_volume_driver: ``` ??? variable list "`lidarr_role_docker_volumes_from`{ .sb-show-on-unchecked }`lidarr2_docker_volumes_from`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_volumes_from: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_volumes_from: ``` ??? variable bool "`lidarr_role_docker_volumes_global`{ .sb-show-on-unchecked }`lidarr2_docker_volumes_global`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_volumes_global: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_volumes_global: ``` ??? variable string "`lidarr_role_docker_working_dir`{ .sb-show-on-unchecked }`lidarr2_docker_working_dir`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_working_dir: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_working_dir: ```
Monitoring & Lifecycle
??? variable bool "`lidarr_role_docker_auto_remove`{ .sb-show-on-unchecked }`lidarr2_docker_auto_remove`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_auto_remove: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_auto_remove: ``` ??? variable bool "`lidarr_role_docker_cleanup`{ .sb-show-on-unchecked }`lidarr2_docker_cleanup`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_cleanup: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_cleanup: ``` ??? variable string "`lidarr_role_docker_force_kill`{ .sb-show-on-unchecked }`lidarr2_docker_force_kill`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_force_kill: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_force_kill: ``` ??? variable dict "`lidarr_role_docker_healthcheck`{ .sb-show-on-unchecked }`lidarr2_docker_healthcheck`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict lidarr_role_docker_healthcheck: ``` ```yaml { .sb-show-on-checked } # Type: dict lidarr2_docker_healthcheck: ``` ??? variable int "`lidarr_role_docker_healthy_wait_timeout`{ .sb-show-on-unchecked }`lidarr2_docker_healthy_wait_timeout`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int lidarr_role_docker_healthy_wait_timeout: ``` ```yaml { .sb-show-on-checked } # Type: int lidarr2_docker_healthy_wait_timeout: ``` ??? variable bool "`lidarr_role_docker_init`{ .sb-show-on-unchecked }`lidarr2_docker_init`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_init: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_init: ``` ??? variable string "`lidarr_role_docker_kill_signal`{ .sb-show-on-unchecked }`lidarr2_docker_kill_signal`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_kill_signal: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_kill_signal: ``` ??? variable string "`lidarr_role_docker_log_driver`{ .sb-show-on-unchecked }`lidarr2_docker_log_driver`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_log_driver: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_log_driver: ``` ??? variable dict "`lidarr_role_docker_log_options`{ .sb-show-on-unchecked }`lidarr2_docker_log_options`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict lidarr_role_docker_log_options: ``` ```yaml { .sb-show-on-checked } # Type: dict lidarr2_docker_log_options: ``` ??? variable bool "`lidarr_role_docker_oom_killer`{ .sb-show-on-unchecked }`lidarr2_docker_oom_killer`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_oom_killer: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_oom_killer: ``` ??? variable int "`lidarr_role_docker_oom_score_adj`{ .sb-show-on-unchecked }`lidarr2_docker_oom_score_adj`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int lidarr_role_docker_oom_score_adj: ``` ```yaml { .sb-show-on-checked } # Type: int lidarr2_docker_oom_score_adj: ``` ??? variable bool "`lidarr_role_docker_output_logs`{ .sb-show-on-unchecked }`lidarr2_docker_output_logs`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_output_logs: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_output_logs: ``` ??? variable bool "`lidarr_role_docker_paused`{ .sb-show-on-unchecked }`lidarr2_docker_paused`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_paused: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_paused: ``` ??? variable bool "`lidarr_role_docker_recreate`{ .sb-show-on-unchecked }`lidarr2_docker_recreate`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_recreate: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_recreate: ``` ??? variable int "`lidarr_role_docker_restart_retries`{ .sb-show-on-unchecked }`lidarr2_docker_restart_retries`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int lidarr_role_docker_restart_retries: ``` ```yaml { .sb-show-on-checked } # Type: int lidarr2_docker_restart_retries: ``` ??? variable string "`lidarr_role_docker_stop_signal`{ .sb-show-on-unchecked }`lidarr2_docker_stop_signal`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_stop_signal: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_stop_signal: ``` ??? variable int "`lidarr_role_docker_stop_timeout`{ .sb-show-on-unchecked }`lidarr2_docker_stop_timeout`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int lidarr_role_docker_stop_timeout: ``` ```yaml { .sb-show-on-checked } # Type: int lidarr2_docker_stop_timeout: ```
Other Options
??? variable list "`lidarr_role_docker_capabilities`{ .sb-show-on-unchecked }`lidarr2_docker_capabilities`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_capabilities: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_capabilities: ``` ??? variable string "`lidarr_role_docker_cgroup_parent`{ .sb-show-on-unchecked }`lidarr2_docker_cgroup_parent`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_cgroup_parent: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_cgroup_parent: ``` ??? variable list "`lidarr_role_docker_commands`{ .sb-show-on-unchecked }`lidarr2_docker_commands`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_commands: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_commands: ``` ??? variable int "`lidarr_role_docker_create_timeout`{ .sb-show-on-unchecked }`lidarr2_docker_create_timeout`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int lidarr_role_docker_create_timeout: ``` ```yaml { .sb-show-on-checked } # Type: int lidarr2_docker_create_timeout: ``` ??? variable string "`lidarr_role_docker_entrypoint`{ .sb-show-on-unchecked }`lidarr2_docker_entrypoint`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_entrypoint: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_entrypoint: ``` ??? variable string "`lidarr_role_docker_env_file`{ .sb-show-on-unchecked }`lidarr2_docker_env_file`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_env_file: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_env_file: ``` ??? variable bool "`lidarr_role_docker_labels_use_common`{ .sb-show-on-unchecked }`lidarr2_docker_labels_use_common`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_labels_use_common: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_labels_use_common: ``` ??? variable bool "`lidarr_role_docker_read_only`{ .sb-show-on-unchecked }`lidarr2_docker_read_only`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_read_only: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_read_only: ``` ??? variable string "`lidarr_role_docker_runtime`{ .sb-show-on-unchecked }`lidarr2_docker_runtime`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_docker_runtime: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_docker_runtime: ``` ??? variable list "`lidarr_role_docker_sysctls`{ .sb-show-on-unchecked }`lidarr2_docker_sysctls`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_sysctls: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_sysctls: ``` ??? variable list "`lidarr_role_docker_ulimits`{ .sb-show-on-unchecked }`lidarr2_docker_ulimits`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_ulimits: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_ulimits: ``` === "Global Override Options" ??? variable bool "`lidarr_role_autoheal_enabled`{ .sb-show-on-unchecked }`lidarr2_autoheal_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable or disable Autoheal monitoring for containers created when deploying # Type: bool (true/false) lidarr_role_autoheal_enabled: true ``` ```yaml { .sb-show-on-checked } # Enable or disable Autoheal monitoring for containers created when deploying # Type: bool (true/false) lidarr2_autoheal_enabled: true ``` ??? variable string "`lidarr_role_depends_on`{ .sb-show-on-unchecked }`lidarr2_depends_on`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # List of container dependencies that must be running before containers start # Type: string lidarr_role_depends_on: "" ``` ```yaml { .sb-show-on-checked } # List of container dependencies that must be running before containers start # Type: string lidarr2_depends_on: "" ``` ??? variable string "`lidarr_role_depends_on_delay`{ .sb-show-on-unchecked }`lidarr2_depends_on_delay`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Delay in seconds before starting containers after dependencies are ready # Type: string (quoted number) lidarr_role_depends_on_delay: "0" ``` ```yaml { .sb-show-on-checked } # Delay in seconds before starting containers after dependencies are ready # Type: string (quoted number) lidarr2_depends_on_delay: "0" ``` ??? variable string "`lidarr_role_depends_on_healthchecks`{ .sb-show-on-unchecked }`lidarr2_depends_on_healthchecks`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable healthcheck waiting for container dependencies # Type: string ("true"/"false") lidarr_role_depends_on_healthchecks: ``` ```yaml { .sb-show-on-checked } # Enable healthcheck waiting for container dependencies # Type: string ("true"/"false") lidarr2_depends_on_healthchecks: ``` ??? variable bool "`lidarr_role_diun_enabled`{ .sb-show-on-unchecked }`lidarr2_diun_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable or disable Diun update notifications for containers created when deploying # Type: bool (true/false) lidarr_role_diun_enabled: true ``` ```yaml { .sb-show-on-checked } # Enable or disable Diun update notifications for containers created when deploying # Type: bool (true/false) lidarr2_diun_enabled: true ``` ??? variable bool "`lidarr_role_dns_enabled`{ .sb-show-on-unchecked }`lidarr2_dns_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable or disable automatic DNS record creation for containers # Type: bool (true/false) lidarr_role_dns_enabled: true ``` ```yaml { .sb-show-on-checked } # Enable or disable automatic DNS record creation for containers # Type: bool (true/false) lidarr2_dns_enabled: true ``` ??? variable bool "`lidarr_role_docker_controller`{ .sb-show-on-unchecked }`lidarr2_docker_controller`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable or disable Saltbox Docker Controller management for containers # Type: bool (true/false) lidarr_role_docker_controller: true ``` ```yaml { .sb-show-on-checked } # Enable or disable Saltbox Docker Controller management for containers # Type: bool (true/false) lidarr2_docker_controller: true ``` ??? variable list "`lidarr_role_docker_networks_alias_custom`{ .sb-show-on-unchecked }`lidarr2_docker_networks_alias_custom`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list lidarr_role_docker_networks_alias_custom: ``` ```yaml { .sb-show-on-checked } # Type: list lidarr2_docker_networks_alias_custom: ``` ??? variable bool "`lidarr_role_docker_volumes_download`{ .sb-show-on-unchecked }`lidarr2_docker_volumes_download`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_docker_volumes_download: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_docker_volumes_download: ``` ??? variable string "`lidarr_role_traefik_api_middleware`{ .sb-show-on-unchecked }`lidarr2_traefik_api_middleware`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_traefik_api_middleware: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_traefik_api_middleware: ``` ??? variable string "`lidarr_role_traefik_api_middleware_http`{ .sb-show-on-unchecked }`lidarr2_traefik_api_middleware_http`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_traefik_api_middleware_http: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_traefik_api_middleware_http: ``` ??? variable bool "`lidarr_role_traefik_autodetect_enabled`{ .sb-show-on-unchecked }`lidarr2_traefik_autodetect_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable Traefik autodetect middleware for containers # Type: bool (true/false) lidarr_role_traefik_autodetect_enabled: false ``` ```yaml { .sb-show-on-checked } # Enable Traefik autodetect middleware for containers # Type: bool (true/false) lidarr2_traefik_autodetect_enabled: false ``` ??? variable bool "`lidarr_role_traefik_crowdsec_enabled`{ .sb-show-on-unchecked }`lidarr2_traefik_crowdsec_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable CrowdSec middleware for containers # Type: bool (true/false) lidarr_role_traefik_crowdsec_enabled: false ``` ```yaml { .sb-show-on-checked } # Enable CrowdSec middleware for containers # Type: bool (true/false) lidarr2_traefik_crowdsec_enabled: false ``` ??? variable bool "`lidarr_role_traefik_error_pages_enabled`{ .sb-show-on-unchecked }`lidarr2_traefik_error_pages_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable custom error pages middleware for containers # Type: bool (true/false) lidarr_role_traefik_error_pages_enabled: false ``` ```yaml { .sb-show-on-checked } # Enable custom error pages middleware for containers # Type: bool (true/false) lidarr2_traefik_error_pages_enabled: false ``` ??? variable bool "`lidarr_role_traefik_gzip_enabled`{ .sb-show-on-unchecked }`lidarr2_traefik_gzip_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable gzip compression middleware for containers # Type: bool (true/false) lidarr_role_traefik_gzip_enabled: false ``` ```yaml { .sb-show-on-checked } # Enable gzip compression middleware for containers # Type: bool (true/false) lidarr2_traefik_gzip_enabled: false ``` ??? variable string "`lidarr_role_traefik_middleware_http`{ .sb-show-on-unchecked }`lidarr2_traefik_middleware_http`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_traefik_middleware_http: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_traefik_middleware_http: ``` ??? variable bool "`lidarr_role_traefik_middleware_http_api_insecure`{ .sb-show-on-unchecked }`lidarr2_traefik_middleware_http_api_insecure`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_traefik_middleware_http_api_insecure: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_traefik_middleware_http_api_insecure: ``` ??? variable bool "`lidarr_role_traefik_middleware_http_insecure`{ .sb-show-on-unchecked }`lidarr2_traefik_middleware_http_insecure`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) lidarr_role_traefik_middleware_http_insecure: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) lidarr2_traefik_middleware_http_insecure: ``` ??? variable string "`lidarr_role_traefik_priority`{ .sb-show-on-unchecked }`lidarr2_traefik_priority`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string lidarr_role_traefik_priority: ``` ```yaml { .sb-show-on-checked } # Type: string lidarr2_traefik_priority: ``` ??? variable bool "`lidarr_role_traefik_robot_enabled`{ .sb-show-on-unchecked }`lidarr2_traefik_robot_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable robots.txt middleware for containers # Type: bool (true/false) lidarr_role_traefik_robot_enabled: true ``` ```yaml { .sb-show-on-checked } # Enable robots.txt middleware for containers # Type: bool (true/false) lidarr2_traefik_robot_enabled: true ``` ??? variable bool "`lidarr_role_traefik_tailscale_enabled`{ .sb-show-on-unchecked }`lidarr2_traefik_tailscale_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable Tailscale-specific Traefik configuration for containers # Type: bool (true/false) lidarr_role_traefik_tailscale_enabled: false ``` ```yaml { .sb-show-on-checked } # Enable Tailscale-specific Traefik configuration for containers # Type: bool (true/false) lidarr2_traefik_tailscale_enabled: false ``` ??? variable bool "`lidarr_role_traefik_wildcard_enabled`{ .sb-show-on-unchecked }`lidarr2_traefik_wildcard_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable wildcard certificate for containers # Type: bool (true/false) lidarr_role_traefik_wildcard_enabled: true ``` ```yaml { .sb-show-on-checked } # Enable wildcard certificate for containers # Type: bool (true/false) lidarr2_traefik_wildcard_enabled: true ``` ??? variable string "`lidarr_role_web_api_http_port`{ .sb-show-on-unchecked }`lidarr2_web_api_http_port`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string (quoted number) lidarr_role_web_api_http_port: ``` ```yaml { .sb-show-on-checked } # Type: string (quoted number) lidarr2_web_api_http_port: ``` ??? variable string "`lidarr_role_web_api_http_scheme`{ .sb-show-on-unchecked }`lidarr2_web_api_http_scheme`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string ("http"/"https") lidarr_role_web_api_http_scheme: ``` ```yaml { .sb-show-on-checked } # Type: string ("http"/"https") lidarr2_web_api_http_scheme: ``` ??? variable dict "`lidarr_role_web_api_http_serverstransport`{ .sb-show-on-unchecked }`lidarr2_web_api_http_serverstransport`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict/omit lidarr_role_web_api_http_serverstransport: ``` ```yaml { .sb-show-on-checked } # Type: dict/omit lidarr2_web_api_http_serverstransport: ``` ??? variable string "`lidarr_role_web_api_port`{ .sb-show-on-unchecked }`lidarr2_web_api_port`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string (quoted number) lidarr_role_web_api_port: ``` ```yaml { .sb-show-on-checked } # Type: string (quoted number) lidarr2_web_api_port: ``` ??? variable string "`lidarr_role_web_api_scheme`{ .sb-show-on-unchecked }`lidarr2_web_api_scheme`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string ("http"/"https") lidarr_role_web_api_scheme: ``` ```yaml { .sb-show-on-checked } # Type: string ("http"/"https") lidarr2_web_api_scheme: ``` ??? variable dict "`lidarr_role_web_api_serverstransport`{ .sb-show-on-unchecked }`lidarr2_web_api_serverstransport`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict/omit lidarr_role_web_api_serverstransport: ``` ```yaml { .sb-show-on-checked } # Type: dict/omit lidarr2_web_api_serverstransport: ``` ??? variable list "`lidarr_role_web_fqdn_override`{ .sb-show-on-unchecked }`lidarr2_web_fqdn_override`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Override the Traefik fully qualified domain name (FQDN) for containers # Type: list lidarr_role_web_fqdn_override: ``` ```yaml { .sb-show-on-checked } # Override the Traefik fully qualified domain name (FQDN) for containers # Type: list lidarr2_web_fqdn_override: ``` !!! example sb-show-on-unchecked "Example Override" ```yaml lidarr_role_web_fqdn_override: - "{{ traefik_host }}" - "lidarr2.{{ user.domain }}" - "lidarr.otherdomain.tld" ``` Note: Include `{{ traefik_host }}` to preserve the default FQDN alongside your custom entries !!! example sb-show-on-checked "Example Override" ```yaml lidarr2_web_fqdn_override: - "{{ traefik_host }}" - "lidarr2.{{ user.domain }}" - "lidarr.otherdomain.tld" ``` Note: Include `{{ traefik_host }}` to preserve the default FQDN alongside your custom entries ??? variable string "`lidarr_role_web_host_override`{ .sb-show-on-unchecked }`lidarr2_web_host_override`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Override the Traefik web host configuration for containers # Type: string lidarr_role_web_host_override: ``` ```yaml { .sb-show-on-checked } # Override the Traefik web host configuration for containers # Type: string lidarr2_web_host_override: ``` !!! example sb-show-on-unchecked "Example Override" ```yaml lidarr_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'lidarr2.' + user.domain }}`)" ``` Note: Use `{{ traefik_host }}` to include the default host configuration in your custom rule !!! example sb-show-on-checked "Example Override" ```yaml lidarr2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'lidarr2.' + user.domain }}`)" ``` Note: Use `{{ traefik_host }}` to include the default host configuration in your custom rule ??? variable string "`lidarr_role_web_http_port`{ .sb-show-on-unchecked }`lidarr2_web_http_port`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string (quoted number) lidarr_role_web_http_port: ``` ```yaml { .sb-show-on-checked } # Type: string (quoted number) lidarr2_web_http_port: ``` ??? variable string "`lidarr_role_web_http_scheme`{ .sb-show-on-unchecked }`lidarr2_web_http_scheme`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string ("http"/"https") lidarr_role_web_http_scheme: ``` ```yaml { .sb-show-on-checked } # Type: string ("http"/"https") lidarr2_web_http_scheme: ``` ??? variable dict "`lidarr_role_web_http_serverstransport`{ .sb-show-on-unchecked }`lidarr2_web_http_serverstransport`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict/omit lidarr_role_web_http_serverstransport: ``` ```yaml { .sb-show-on-checked } # Type: dict/omit lidarr2_web_http_serverstransport: ``` ??? variable string "`lidarr_role_web_scheme`{ .sb-show-on-unchecked }`lidarr2_web_scheme`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # URL scheme to use for web access to containers # Type: string ("http"/"https") lidarr_role_web_scheme: ``` ```yaml { .sb-show-on-checked } # URL scheme to use for web access to containers # Type: string ("http"/"https") lidarr2_web_scheme: ``` ??? variable dict "`lidarr_role_web_serverstransport`{ .sb-show-on-unchecked }`lidarr2_web_serverstransport`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict/omit lidarr_role_web_serverstransport: ``` ```yaml { .sb-show-on-checked } # Type: dict/omit lidarr2_web_serverstransport: ```