diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml index f05156dda..cf4f4085f 100644 --- a/.github/workflows/pre-commit.yml +++ b/.github/workflows/pre-commit.yml @@ -19,23 +19,23 @@ jobs: steps: - name: 📥 Checkout repository - uses: actions/checkout@v5 + uses: actions/checkout@9f698171ed81b15d1823a05fc7211befd50c8ae0 # v6.0.3 with: fetch-depth: 0 - name: 🐍 Setup Python 3.11 - uses: actions/setup-python@v6 + uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 with: python-version: "3.11" cache: "pip" - name: 📦 Setup Node.js 20 - uses: actions/setup-node@v5 + uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 with: node-version: "20" - name: 🔧 Cache pre-commit environments - uses: actions/cache@v4 + uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0 with: path: | ~/.cache/pre-commit @@ -51,6 +51,6 @@ jobs: pip install pre-commit - name: 🔍 Run documentation quality checks - uses: pre-commit/action@v3.0.1 + uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1 with: extra_args: --all-files --show-diff-on-failure diff --git a/.github/workflows/prowlarr-ci.yml b/.github/workflows/prowlarr-ci.yml index 844367bd9..b76d98455 100644 --- a/.github/workflows/prowlarr-ci.yml +++ b/.github/workflows/prowlarr-ci.yml @@ -18,16 +18,16 @@ jobs: env: API_KEY: fakeapikey steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@9f698171ed81b15d1823a05fc7211befd50c8ae0 # v6.0.3 - name: Setup Python - uses: actions/setup-python@v6 + uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 with: python-version: "3.10" cache: "pip" - name: Setup Node.js - uses: actions/setup-node@v5 + uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 with: node-version: "18" @@ -35,7 +35,7 @@ jobs: run: pip install -r requirements.txt - name: Cache pre-commit hooks - uses: actions/cache@v4 + uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0 with: path: ~/.cache/pre-commit key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }} diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1702cda11..781b2526e 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -44,8 +44,8 @@ repos: stages: [pre-commit, pre-merge-commit, pre-push, manual] # YAML formatting - - repo: https://github.com/pre-commit/mirrors-prettier - rev: v4.0.0-alpha.8 + - repo: https://github.com/rbubley/mirrors-prettier + rev: v3.8.4 hooks: - id: prettier files: \.(yaml|yml)$ diff --git a/lidarr/activity.md b/lidarr/activity.md index a07c06c09..02bf6156c 100644 --- a/lidarr/activity.md +++ b/lidarr/activity.md @@ -31,7 +31,7 @@ The queue table shows the following columns by default: Status, Artist, Album Ti ### Queue statuses | Icon | Status | Description | Resolution | -|---|---|---|---| +| --- | --- | --- | --- | | Grey cloud | Queued | The item is waiting in the download client and hasn't started downloading yet. | Wait for the download client to start it. | | Grey clock | Release Pending | The download is waiting for a Delay Profile timer to expire before Lidarr sends it to the download client. | Wait for the delay to pass, or adjust your Delay Profile in Settings. | | Yellow arrow | Downloading | The item is actively downloading in the download client. | N/A. | @@ -53,7 +53,7 @@ Each row has action icons on the right: Click **Options** in the queue toolbar to open Table Options: | Option | Default | Description | -|---|---|---| +| --- | --- | --- | | Page Size | 20 | Number of queue items shown per page. | | Show Unknown Artist Items | On | Shows items in Lidarr's download client category that Lidarr can't match to any artist in your library (for example, removed artists or items added to the category manually). | | Columns | (see below) | Choose which columns are visible and their display order. | diff --git a/lidarr/beets-integration.md b/lidarr/beets-integration.md index 12d8550cb..882eaac34 100644 --- a/lidarr/beets-integration.md +++ b/lidarr/beets-integration.md @@ -134,7 +134,7 @@ foreach ($dir in $albumDirs) { ## Trade-offs | | | -|---|---| +| --- | --- | | **Benefit** | beets runs once at import time with any plugins you want, writing a full tag set that Lidarr wouldn't produce on its own. | | **Benefit** | No persistent beets database to maintain or back up. | | **Drawback** | Tags written at import time are never updated. If MusicBrainz data improves, or a plugin source updates its data (for example, updated ReplayGain values), the library files won't reflect it until you re-import or run beets manually. | @@ -189,7 +189,7 @@ Two scenarios where the tools can conflict: ## Trade-offs | | | -|---|---| +| --- | --- | | **Benefit** | beets maintains tags on an ongoing basis; as plugin data sources update, you can re-run beets to pull in new values. | | **Benefit** | beets' persistent library enables more sophisticated queries, playlist generation, and plugin behaviour. | | **Drawback** | Requires careful beets configuration to prevent file moves. One misconfiguration can disorganise a large library. | diff --git a/lidarr/calendar.md b/lidarr/calendar.md index 8205c7424..edcb92b73 100644 --- a/lidarr/calendar.md +++ b/lidarr/calendar.md @@ -17,7 +17,7 @@ The Calendar page shows album releases from artists in your library, laid out we Each release tile is color-coded to show its current status: | Color | Meaning | -|---|---| +| --- | --- | | Green | All tracks downloaded; Lidarr has a complete copy of this release. | | Blue | Monitored and upcoming; the release date is in the future. | | Purple | Currently downloading; the release is in the queue or was recently grabbed. | @@ -38,7 +38,7 @@ Lidarr can expose your calendar as an iCal feed that any calendar client support Click the **iCal Feed** button on the Calendar page to open the feed configuration dialog. The options available are: | Field | Default | Description | -|---|---|---| +| --- | --- | --- | | Include Unmonitored | Off | When enabled, unmonitored album releases are included in the feed as well as monitored ones. | | Past Days | 7 | How many days into the past the feed includes. | | Future Days | 28 | How many days into the future the feed includes. | @@ -56,14 +56,14 @@ The **Options** button opens the Calendar Options dialog, split into two section **Local** (apply to this browser only): | Option | Default | Description | -|---|---|---| +| --- | --- | --- | | Collapse Multiple Albums | Off | When more than one album from the same artist releases on the same day, collapse them into a single tile instead of showing each one. | | Icon for Cutoff Unmet | Off | Show a visual indicator on release tiles where files exist but the quality cutoff hasn't been met. | **Global** (apply across all browsers and users): | Option | Description | -|---|---| +| --- | --- | | First Day of Week | Sets whether weeks start on Sunday or Monday. | | Week Column Header | Controls the date format shown above each day column (for example, `Tue 3/25`). | | Time Format | Sets the time format used across the calendar (12-hour or 24-hour). | diff --git a/lidarr/custom-scripts.md b/lidarr/custom-scripts.md index 9e925ebce..10fbe2f1c 100644 --- a/lidarr/custom-scripts.md +++ b/lidarr/custom-scripts.md @@ -19,7 +19,7 @@ A custom script can be any executable accessible by the user Lidarr is running a Lidarr writes script output to the log files: | Output | Log level | Log file | -|---|---|---| +| --- | --- | --- | | `stdout` | `Debug` | `config/logs/Lidarr.debug.txt` | | `stderr` | `Error` | `config/logs/Lidarr.txt` | | Script trigger | `Trace` | `config/logs/Lidarr.trace.txt` | @@ -45,7 +45,7 @@ Lidarr passes data to your script through environment variables. The variables a These three variables are present in every event. | Environment Variable | Details | -|---|---| +| --- | --- | | `Lidarr_EventType` | The event name: `Grab`, `AlbumDownload`, `Rename`, `TrackRetag`, `ArtistAdd`, `ArtistDeleted`, `AlbumDeleted`, `HealthIssue`, `HealthRestored`, `ApplicationUpdate`, `Test` | | `Lidarr_InstanceName` | The Lidarr instance name (set in Settings → General) | | `Lidarr_ApplicationUrl` | The configured application URL (set in Settings → General) | @@ -55,7 +55,7 @@ These three variables are present in every event. Fired when Lidarr sends a release to a download client. | Environment Variable | Details | -|---|---| +| --- | --- | | `Lidarr_EventType` | `Grab` | | `Lidarr_Artist_Id` | Internal Lidarr ID for the artist | | `Lidarr_Artist_Name` | Artist name | @@ -86,7 +86,7 @@ Fired when Lidarr sends a release to a download client. Fired after Lidarr has successfully imported a downloaded album into the library. `Lidarr_EventType` is `AlbumDownload` for both initial imports and upgrades. | Environment Variable | Details | -|---|---| +| --- | --- | | `Lidarr_EventType` | `AlbumDownload` | | `Lidarr_Artist_Id` | Internal Lidarr ID for the artist | | `Lidarr_Artist_Name` | Artist name | @@ -113,7 +113,7 @@ Fired after Lidarr has successfully imported a downloaded album into the library Fired after Lidarr renames one or more track files for an artist. | Environment Variable | Details | -|---|---| +| --- | --- | | `Lidarr_EventType` | `Rename` | | `Lidarr_Artist_Id` | Internal Lidarr ID for the artist | | `Lidarr_Artist_Name` | Artist name | @@ -131,7 +131,7 @@ Fired after Lidarr renames one or more track files for an artist. Fired after Lidarr rewrites tags on one or more track files. | Environment Variable | Details | -|---|---| +| --- | --- | | `Lidarr_EventType` | `TrackRetag` | | `Lidarr_Artist_Id` | Internal Lidarr ID for the artist | | `Lidarr_Artist_Name` | Artist name | @@ -164,7 +164,7 @@ Fired after Lidarr rewrites tags on one or more track files. Fired when you add an artist to Lidarr. | Environment Variable | Details | -|---|---| +| --- | --- | | `Lidarr_EventType` | `ArtistAdd` | | `Lidarr_Artist_Id` | Internal Lidarr ID for the artist | | `Lidarr_Artist_Title` | Artist name | @@ -179,7 +179,7 @@ Fired when you add an artist to Lidarr. Fired when you remove an artist from Lidarr. | Environment Variable | Details | -|---|---| +| --- | --- | | `Lidarr_EventType` | `ArtistDeleted` | | `Lidarr_Artist_Id` | Internal Lidarr ID for the artist | | `Lidarr_Artist_Title` | Artist name | @@ -195,7 +195,7 @@ Fired when you remove an artist from Lidarr. Fired when you remove an album from Lidarr. | Environment Variable | Details | -|---|---| +| --- | --- | | `Lidarr_EventType` | `AlbumDeleted` | | `Lidarr_Artist_Id` | Internal Lidarr ID for the artist | | `Lidarr_Artist_Name` | Artist name | @@ -216,7 +216,7 @@ Fired when you remove an album from Lidarr. Fired when Lidarr detects a health check failure. | Environment Variable | Details | -|---|---| +| --- | --- | | `Lidarr_EventType` | `HealthIssue` | | `Lidarr_Health_Issue_Level` | Severity level: `Ok`, `Notice`, `Warning`, or `Error` | | `Lidarr_Health_Issue_Message` | Human-readable description of the issue | @@ -228,7 +228,7 @@ Fired when Lidarr detects a health check failure. Fired when a failing health check returns to a healthy state. | Environment Variable | Details | -|---|---| +| --- | --- | | `Lidarr_EventType` | `HealthRestored` | | `Lidarr_Health_Restored_Level` | Previous severity level | | `Lidarr_Health_Restored_Message` | Description of the check that recovered | @@ -240,7 +240,7 @@ Fired when a failing health check returns to a healthy state. Fired after Lidarr updates itself to a new version. | Environment Variable | Details | -|---|---| +| --- | --- | | `Lidarr_EventType` | `ApplicationUpdate` | | `Lidarr_Update_Message` | Update changelog message | | `Lidarr_Update_NewVersion` | Version that was just installed | diff --git a/lidarr/environment-variables.md b/lidarr/environment-variables.md index 943387220..ef95786ee 100644 --- a/lidarr/environment-variables.md +++ b/lidarr/environment-variables.md @@ -143,7 +143,7 @@ Branch=master ### Available Keys | Key | Description | Example | -|-----|-------------|---------| +| ----- | ------------- | --------- | | `PackageVersion` | Custom package version identifier | `1.0.0-custom` | | `PackageAuthor` | Package maintainer name | `Community Package` | | `PackageGlobalMessage` | Message displayed in UI | `Custom build for Debian 11` | @@ -155,7 +155,7 @@ Branch=master ### UpdateMethod Values | Value | Numeric | Description | Use Case | -|-------|---------|-------------|----------| +| ------- | --------- | ------------- | ---------- | | `BuiltIn` | 0 | Default built-in updater | Standard installations | | `Script` | 1 | Updates via custom script | Advanced custom setups | | `External` | 10 | Updates managed externally | Package managers, Docker | diff --git a/lidarr/faq.md b/lidarr/faq.md index ba94ac012..6d4502d28 100644 --- a/lidarr/faq.md +++ b/lidarr/faq.md @@ -74,7 +74,7 @@ A few common causes: Lidarr supports three prefixes for direct MBID lookup. All three work the same way and are case-insensitive: | Prefix | Example | -|---|---| +| --- | --- | | `lidarr:` | `lidarr:9255f594-b912-4bdf-87a2-ada04502a459` | | `lidarrid:` | `lidarrid:9255f594-b912-4bdf-87a2-ada04502a459` | | `mbid:` | `mbid:9255f594-b912-4bdf-87a2-ada04502a459` | diff --git a/lidarr/import-troubleshooting.md b/lidarr/import-troubleshooting.md index 68aac349b..fab41eed6 100644 --- a/lidarr/import-troubleshooting.md +++ b/lidarr/import-troubleshooting.md @@ -50,7 +50,7 @@ Standalone track imports outside the album context use a **60% similarity** thre The distance score is a weighted combination of how well each field matches. Lidarr adapts the weights from [beets' default configuration](https://beets.readthedocs.io/), with MusicBrainz IDs as the strongest signals: | Signal | Weight | Notes | -|---|---|---| +| --- | --- | --- | | `recording_id` | 10.0 | MusicBrainz Recording MBID. If present and correct, imports almost always succeed. | | `album_id` | 5.0 | MusicBrainz Release MBID. | | `artist` | 3.0 | Artist name (Levenshtein distance after normalisation). | diff --git a/lidarr/metadata-troubleshooting.md b/lidarr/metadata-troubleshooting.md index 23c5ac3f8..f1470d2fd 100644 --- a/lidarr/metadata-troubleshooting.md +++ b/lidarr/metadata-troubleshooting.md @@ -197,7 +197,7 @@ To add a Spotify relationship on MusicBrainz, open the release and go to **Edit* ## Retry or wait | Situation | Action | -|---|---| +| --- | --- | | You just submitted an edit at MusicBrainz | Wait ~3 hours, then **Refresh Artist** in Lidarr | | You just uploaded cover art to the Cover Art Archive | Allow days, not hours — covers propagate slower than metadata | | A release status was `unknown` and you changed it | Wait ~3 hours after the edit's visible on MusicBrainz, then **Refresh Artist** | diff --git a/lidarr/naming-guide.md b/lidarr/naming-guide.md index d57286b32..16e912eb6 100644 --- a/lidarr/naming-guide.md +++ b/lidarr/naming-guide.md @@ -48,7 +48,7 @@ Wrap tokens in `{}`. Lidarr substitutes them at import time. Any token that reso ## Artist tokens | Token | Description | -|---|---| +| --- | --- | | `{Artist Name}` | Full artist name as stored in MusicBrainz. | | `{Artist NameThe}` | Artist name with a leading "The" moved to the end, for example, `Beatles, The`. Useful for consistent alphabetical sorting. | | `{Artist CleanName}` | Artist name with illegal filesystem characters removed. | @@ -59,7 +59,7 @@ Wrap tokens in `{}`. Lidarr substitutes them at import time. Any token that reso ## Album tokens | Token | Description | -|---|---| +| --- | --- | | `{Album Title}` | Album title. | | `{Album TitleThe}` | Album title with a leading "The" moved to the end. | | `{Album CleanTitle}` | Album title with illegal filesystem characters removed. | @@ -72,7 +72,7 @@ Wrap tokens in `{}`. Lidarr substitutes them at import time. Any token that reso ## Track tokens | Token | Description | -|---|---| +| --- | --- | | `{Track Title}` | Track title. | | `{Track ArtistName}` | Track-level artist name. Useful for Various Artists compilations where each track has a different credited artist. | | `{Track ArtistNameThe}` | Track artist name with "The" moved to the end. | @@ -81,7 +81,7 @@ Wrap tokens in `{}`. Lidarr substitutes them at import time. Any token that reso ## Medium (disc) tokens | Token | Description | -|---|---| +| --- | --- | | `{medium:0}` | Disc number, single digit. | | `{medium:00}` | Disc number zero-padded to 2 digits. | | `{Medium Format}` | Physical format of the disc: CD, Vinyl, Digital Media, etc. | @@ -89,7 +89,7 @@ Wrap tokens in `{}`. Lidarr substitutes them at import time. Any token that reso ## Quality and technical tokens | Token | Description | -|---|---| +| --- | --- | | `{Quality Title}` | Quality profile name as defined in Lidarr (for example, FLAC, MP3-320). | | `{Quality Full}` | Full quality string including proper/repack designation. | | `{MediaInfo AudioBitRate}` | Audio bitrate (for example, 320kbps). Only available after import; blank on pre-import rename previews. | diff --git a/lidarr/settings.md b/lidarr/settings.md index 65445fb0f..61b949151 100644 --- a/lidarr/settings.md +++ b/lidarr/settings.md @@ -60,14 +60,14 @@ Example: `{Artist Name}` → `/music/The Beatles/` ## Folders | Setting | Default | Description | -|---|---|---| +| --- | --- | --- | | **Create Empty Artist Folders** | Off | Lidarr creates an artist folder immediately when you add an artist, even before importing any tracks. | | **Delete Empty Folders** | Off | Lidarr automatically removes empty artist and album folders after deleting or moving files. | ## Importing | Setting | Default | Description | -|---|---|---| +| --- | --- | --- | | **Skip Free Space Check** | Off | Skip the available disk space check before importing. Only enable this if Lidarr can't correctly detect free space (some network shares and unusual storage setups). | | **Minimum Free Space** | 100 MB | Lidarr will refuse to import if available space in the root folder falls below this value. | | **Use Hardlinks Instead of Copy** | On | Use hardlinks when the source and destination are on the same filesystem. Hardlinks avoid copying data and allow seeding to continue. Falls back to copy if hardlinks aren't supported. | @@ -96,7 +96,7 @@ Matching files are then filtered against the configured extension list. Files th ## File Management | Setting | Default | Description | -|---|---|---| +| --- | --- | --- | | **Unmonitor Deleted Tracks** | Off | When something outside Lidarr deletes a track file from disk, automatically unmonitor that track. | | **Download Propers and Repacks** | Prefer and Upgrade | How to handle proper/repack releases. **Prefer and Upgrade** grabs and upgrades to propers when found. **Don't Upgrade Automatically** includes them in scores but won't autograb. **Don't Prefer** treats them as equal to the original release. | | **Analyse Audio Files** | On | Read audio file metadata (bitrate, sample rate, bit depth) to improve quality detection. Disabling this makes quality detection rely solely on filename parsing. | @@ -108,7 +108,7 @@ Matching files are then filtered against the configured extension list. Files th These settings apply to Linux and macOS only. Leave disabled on Windows. | Setting | Default | Description | -|---|---|---| +| --- | --- | --- | | **Set Permissions** | Off | Set file and folder permissions on imported files. | | **chmod Folder** | 755 | Octal permission mode applied to folders on import (for example, `755` = rwxr-xr-x). | | **chown Group** | (empty) | Group to assign to imported files and folders. The Lidarr process user must be a member of this group. | @@ -116,7 +116,7 @@ These settings apply to Linux and macOS only. Leave disabled on Windows. ## Recycling Bin | Setting | Default | Description | -|---|---|---| +| --- | --- | --- | | **Recycle Bin** | (empty) | Path to a recycling bin folder. When Lidarr deletes files, they're moved here rather than permanently deleted. Leave empty to skip the recycle bin. | | **Recycle Bin Cleanup** | 7 days | Number of days before files in the recycle bin are permanently deleted. Set to `0` to disable automatic cleanup. | @@ -129,7 +129,6 @@ Click **Add (+)** to add a root folder. The path must exist and Lidarr must have > Don't point a root folder at a cloud storage mount (Dropbox, OneDrive, Google Drive). Lidarr writes audio tags and metadata frequently; cloud storage APIs have rate limits that will cause failures. {.is-warning} - ## Metadata Profiles {#metadata-profiles} @@ -139,14 +138,14 @@ Metadata profiles control which release types are visible per artist. Lidarr hid ### Fields | Field | Description | -|---|---| +| --- | --- | | **Name** | Profile name. | | **Release Types** | Checkboxes for each MusicBrainz release type. Only releases matching a checked type appear for artists using this profile. | ### Release Types | Type | Description | -|---|---| +| --- | --- | | **Albums** | Standard studio albums. | | **Singles** | Single releases (one or a few tracks). | | **EPs** | Extended plays, longer than a single but shorter than an album. | @@ -158,7 +157,6 @@ You can include or exclude secondary types (Compilation, Soundtrack, Spokenword, > MusicBrainz determines release types. If a release you expect to see is missing, check its entry on MusicBrainz: the type may be `Unknown`, which Lidarr can't filter on, or the primary type may be one you have unchecked in your profile. {.is-info} - ## Release Profiles {#release-profiles} @@ -168,7 +166,7 @@ Release profiles filter and score releases based on their titles. Use them to re ### Fields | Field | Description | -|---|---| +| --- | --- | | **Must Contain** | Comma-separated list of terms (or regex patterns) that a release title must include. Lidarr rejects releases that don't match. | | **Must Not Contain** | Comma-separated list of terms a release title must not include. Lidarr rejects releases that match any term. | | **Preferred** | Terms with associated scores. Positive scores boost a release; negative scores penalise it. Separate terms with commas to share a score across more than one term. | @@ -179,7 +177,6 @@ Release profiles filter and score releases based on their titles. Use them to re > Release profiles apply at **grab/download time**: they filter and score releases from indexers before Lidarr sends anything to a download client. They have no effect on which MusicBrainz release (pressing, edition, format) Lidarr matches your already-downloaded files to during import. See [FAQ → Can Lidarr prefer a specific pressing or format during import?](/lidarr/faq#can-lidarr-prefer-a-specific-pressing-or-format-during-import) for the import side of this. {.is-info} - ## Custom Formats {#custom-formats-2} @@ -198,7 +195,7 @@ Each custom format contains one or more specifications. A specification defines Common specification types for music: | Specification | Matches against | -|---|---| +| --- | --- | | **Release Title** | The full release title string from the indexer. Supports regex. | | **Release Group** | The release group part of the title, if parseable. | | **Indexer Flag** | Indexer-specific flags (Freeleech, Halfleech, etc.) where the indexer supports them. | @@ -214,7 +211,6 @@ Two ways to test how Lidarr will parse a release name before committing to a pro **Via the Servarr Discord bot:** In the `#bot-spam` channel, run `/parser lidarr ` (for example, `/parser lidarr Artist.Album.2022.FLAC-GROUP`). The bot replies with the same parsed breakdown. Useful for quick spot-checks without opening the UI. - # Quality {#quality} @@ -224,7 +220,7 @@ The Quality page defines size thresholds for each quality level. Lidarr uses the For audio, size limits use **kilobits per second (kbps)**. Lidarr computes a bitrate from the file size and duration and compares it to the configured range. | Column | Description | -|---|---| +| --- | --- | | **Quality** | The quality name (for example, FLAC, MP3-320, MP3-256). | | **Min** | Minimum acceptable bitrate in kbps. Lidarr rejects releases below this. Set to `0` to disable the lower bound. | | **Preferred** | The bitrate Lidarr aims for when scoring releases. Releases at this level receive a higher score than those at the minimum. | @@ -233,7 +229,6 @@ For audio, size limits use **kilobits per second (kbps)**. Lidarr computes a bit > FLAC is lossless and doesn't have a consistent bitrate; its effective bitrate varies by content. The FLAC entry in quality definitions serves primarily as a file-size sanity check rather than strict bitrate enforcement. {.is-info} - # Download Clients {#download-clients} @@ -271,7 +266,7 @@ Click **Add (+)**, choose a client type, and fill in the connection details. ### Common Fields (all clients) | Field | Description | -|---|---| +| --- | --- | | **Name** | Label for this client, shown in activity and logs. | | **Enable** | Whether Lidarr actively monitors this client. | | **Host** | Hostname or IP of the download client. | @@ -293,7 +288,7 @@ Click **Add (+)**, choose a client type, and fill in the connection details. ### Torrent-Only Fields | Field | Description | -|---|---| +| --- | --- | | **Post-Import Category** | Category to assign after import. Note: setting this disables completed-download removal, since Lidarr can no longer identify the torrent as one it manages. | | **Initial State** | Whether new torrents start paused or downloading immediately. | @@ -317,7 +312,7 @@ Lidarr can set seed ratio and time goals via the torrent client's API when you a ## Completed Download Handling | Setting | Description | -|---|---| +| --- | --- | | **Enable** (Advanced, global) | Automatically import completed downloads from the download client. Disabling this means Lidarr will never import anything, so leave it enabled unless you have a specific reason to disable it. | | **Remove** (per-client) | After import, ask the download client to remove the completed item. For torrents, removal only occurs when the client reports seeding is complete and the torrent is paused/stopped. | @@ -326,7 +321,7 @@ Lidarr can set seed ratio and time goals via the torrent client's API when you a Failed download handling is available for SABnzbd and NZBGet only. It isn't supported for torrent clients. | Setting | Description | -|---|---| +| --- | --- | | **Redownload** | When a download fails, automatically search for a replacement. | | **(Advanced) Remove** | Remove the failed download from the client when Lidarr detects the failure. | @@ -341,7 +336,6 @@ A mapping translates a remote path (as reported by the download client) to a loc > If both Lidarr and the download client are in Docker containers on the same host with matching volume mounts, a remote path mapping isn't needed. See [TRaSH's Remote Path Mapping guide](https://trash-guides.info/Radarr/Radarr-remote-path-mapping/) for diagnosis and setup. {.is-info} - # Connect {#connections} @@ -354,7 +348,7 @@ Connections send notifications or trigger actions when events occur in Lidarr. C Click **Add (+)** and select a connection type. Most connections share these fields: | Field | Description | -|---|---| +| --- | --- | | **Name** | Label for this connection. | | **On Grab** | Trigger when Lidarr sends a release to a download client. | | **On Release Import** | Trigger when a downloaded release is successfully imported. | @@ -371,7 +365,6 @@ Click **Add (+)** and select a connection type. Most connections share these fie For **Custom Script** connections, see the [Custom Scripts](/lidarr/custom-scripts) page for the full list of environment variables available per event. - # Tags {#tags} diff --git a/lidarr/tips-and-tricks.md b/lidarr/tips-and-tricks.md index 80ae653de..c094b5fa4 100644 --- a/lidarr/tips-and-tricks.md +++ b/lidarr/tips-and-tricks.md @@ -22,7 +22,7 @@ Your download folder and music library root folder can't be the same location. M Keep two locations separate: -``` +```text /data/ downloads/ ← download client writes here music/ ← Lidarr root folder (your library) @@ -37,7 +37,7 @@ On import, Lidarr moves (or hardlinks) files from `downloads/` into `music/`. Th If you're running more than one download client — say, a Usenet client alongside a torrent client — give each its own subfolder under `downloads/` and set a matching category in Lidarr: -``` +```text /data/ downloads/ usenet/ ← SABnzbd / NZBGet category: "lidarr" @@ -185,7 +185,7 @@ Before setting up custom format scoring, consider tightening the FLAC quality de In **Settings → Quality**, set the FLAC row to: | | Min | Preferred | Max | -|---|---|---|---| +| --- | --- | --- | --- | | FLAC | 0 | 895 | 1400 | | FLAC 24bit | 0 | 895 | 1495 | @@ -312,7 +312,7 @@ Tags releases from a vinyl source, for libraries that want to avoid or specifica After creating the formats, assign scores in **Settings → Profiles → [your profile] → Custom Formats**. The table below implements a setup that requires releases to match at least one positive format before Lidarr will grab them, prefers CD over WEB, and actively avoids vinyl. | Custom Format | Score | -|---|---| +| --- | --- | | Preferred Groups | 100 | | CD | 10 | | Lossless | 10 | @@ -421,4 +421,4 @@ As long as the root folder paths in the backup are still valid on the destinatio - [Metadata Troubleshooting](/lidarr/metadata-troubleshooting) — when MusicBrainz data is missing or stale - [Import Troubleshooting](/lidarr/import-troubleshooting) — when downloads finish but don't import - [Troubleshooting](/lidarr/troubleshooting) — general runtime issues -- [TRaSH Guides](https://trash-guides.info/) — community recipes for media server setups \ No newline at end of file +- [TRaSH Guides](https://trash-guides.info/) — community recipes for media server setups diff --git a/lidarr/wanted.md b/lidarr/wanted.md index 9f5856d80..27e189ef7 100644 --- a/lidarr/wanted.md +++ b/lidarr/wanted.md @@ -35,7 +35,7 @@ Each row has two action icons on the right: ## Options | Option | Default | Description | -|---|---|---| +| --- | --- | --- | | Page Size | 20 | Number of albums shown per page. | | Columns | (see below) | Choose which columns are visible and their display order. | diff --git a/prowlarr/environment-variables.md b/prowlarr/environment-variables.md index 277cbc9ad..4e2a2cffa 100644 --- a/prowlarr/environment-variables.md +++ b/prowlarr/environment-variables.md @@ -143,7 +143,7 @@ Branch=master ### Available Keys | Key | Description | Example | -|-----|-------------|---------| +| ----- | ------------- | --------- | | `PackageVersion` | Custom package version identifier | `1.0.0-custom` | | `PackageAuthor` | Package maintainer name | `Community Package` | | `PackageGlobalMessage` | Message displayed in UI | `Custom build for Debian 11` | @@ -155,7 +155,7 @@ Branch=master ### UpdateMethod Values | Value | Numeric | Description | Use Case | -|-------|---------|-------------|----------| +| ------- | --------- | ------------- | ---------- | | `BuiltIn` | 0 | Default built-in updater | Standard installations | | `Script` | 1 | Updates via custom script | Advanced custom setups | | `External` | 10 | Updates managed externally | Package managers, Docker | diff --git a/prowlarr/faq.md b/prowlarr/faq.md index 8182f3aee..7cf1f9a5c 100644 --- a/prowlarr/faq.md +++ b/prowlarr/faq.md @@ -166,7 +166,7 @@ When Full Sync is enabled, Prowlarr compares the following settings between the ### Sonarr | Setting | Description | Code Reference | -|---------|-------------|----------------| +| --------- | ------------- | ---------------- | | **Indexer Name** | The name of the indexer (with "(Prowlarr)" suffix) | `SonarrIndexer.cs:71` | | **Enable RSS** | Whether RSS feeds are enabled for the indexer | `SonarrIndexer.cs:68` | | **Enable Automatic Search** | Whether automatic searches are enabled | `SonarrIndexer.cs:69` | @@ -188,7 +188,7 @@ When Full Sync is enabled, Prowlarr compares the following settings between the ### Radarr | Setting | Description | Code Reference | -|---------|-------------|----------------| +| --------- | ------------- | ---------------- | | **Indexer Name** | The name of the indexer (with "(Prowlarr)" suffix) | `RadarrIndexer.cs:61` | | **Enable RSS** | Whether RSS feeds are enabled for the indexer | `RadarrIndexer.cs:58` | | **Enable Automatic Search** | Whether automatic searches are enabled | `RadarrIndexer.cs:59` | @@ -207,7 +207,7 @@ When Full Sync is enabled, Prowlarr compares the following settings between the ### Lidarr | Setting | Description | Code Reference | -|---------|-------------|----------------| +| --------- | ------------- | ---------------- | | **Indexer Name** | The name of the indexer (with "(Prowlarr)" suffix) | `LidarrIndexer.cs:65` | | **Enable RSS** | Whether RSS feeds are enabled for the indexer | `LidarrIndexer.cs:62` | | **Enable Automatic Search** | Whether automatic searches are enabled | `LidarrIndexer.cs:63` | diff --git a/radarr/environment-variables.md b/radarr/environment-variables.md index e9b64a276..f0ab98448 100644 --- a/radarr/environment-variables.md +++ b/radarr/environment-variables.md @@ -145,7 +145,7 @@ Branch=master ### Available Keys | Key | Description | Example | -|-----|-------------|---------| +| ----- | ------------- | --------- | | `PackageVersion` | Custom package version identifier | `1.0.0-custom` | | `PackageAuthor` | Package maintainer name | `Community Package` | | `PackageGlobalMessage` | Message displayed in UI | `Custom build for Debian 11` | @@ -157,7 +157,7 @@ Branch=master ### UpdateMethod Values | Value | Numeric | Description | Use Case | -|-------|---------|-------------|----------| +| ------- | --------- | ------------- | ---------- | | `BuiltIn` | 0 | Default built-in updater | Standard installations | | `Script` | 1 | Updates via custom script | Advanced custom setups | | `External` | 10 | Updates managed externally | Package managers, Docker | diff --git a/readarr/environment-variables.md b/readarr/environment-variables.md index 38dba5f66..a920380c5 100644 --- a/readarr/environment-variables.md +++ b/readarr/environment-variables.md @@ -28,7 +28,7 @@ The config namespaces are shared between all Servarr apps and correspond to the ## Environment Variables Table | Config Option | Namespace | Variable Name | Full Environment Variable | -|---------------|-----------|---------------|---------------------------| +| --------------- | ----------- | --------------- | --------------------------- | | `InstanceName` | `APP` | `INSTANCENAME` | `READARR__APP__INSTANCENAME` | | `Theme` | `APP` | `THEME` | `READARR__APP__THEME` | | `LaunchBrowser` | `APP` | `LAUNCHBROWSER` | `READARR__APP__LAUNCHBROWSER` | diff --git a/sonarr/environment-variables.md b/sonarr/environment-variables.md index 43e17ef0a..64ab96267 100644 --- a/sonarr/environment-variables.md +++ b/sonarr/environment-variables.md @@ -143,7 +143,7 @@ Branch=main ### Available Keys | Key | Description | Example | -|-----|-------------|---------| +| ----- | ------------- | --------- | | `PackageVersion` | Custom package version identifier | `1.0.0-custom` | | `PackageAuthor` | Package maintainer name | `Community Package` | | `PackageGlobalMessage` | Message displayed in UI | `Custom build for Debian 11` | @@ -155,7 +155,7 @@ Branch=main ### UpdateMethod Values | Value | Numeric | Description | Use Case | -|-------|---------|-------------|----------| +| ------- | --------- | ------------- | ---------- | | `BuiltIn` | 0 | Default built-in updater | Standard installations | | `Script` | 1 | Updates via custom script | Advanced custom setups | | `External` | 10 | Updates managed externally | Package managers, Docker |