Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
8 changes: 4 additions & 4 deletions .github/workflows/prowlarr-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,24 +18,24 @@ 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"

- name: Install Python dependencies
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') }}
Expand Down
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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)$
Expand Down
4 changes: 2 additions & 2 deletions lidarr/activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand All @@ -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. |
Expand Down
4 changes: 2 additions & 2 deletions lidarr/beets-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down Expand Up @@ -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. |
Expand Down
8 changes: 4 additions & 4 deletions lidarr/calendar.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand All @@ -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. |
Expand All @@ -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). |
Expand Down
24 changes: 12 additions & 12 deletions lidarr/custom-scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Expand All @@ -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) |
Expand All @@ -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 |
Expand Down Expand Up @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand Down Expand Up @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand Down
4 changes: 2 additions & 2 deletions lidarr/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Expand All @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion lidarr/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Expand Down
2 changes: 1 addition & 1 deletion lidarr/import-troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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). |
Expand Down
2 changes: 1 addition & 1 deletion lidarr/metadata-troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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** |
Expand Down
10 changes: 5 additions & 5 deletions lidarr/naming-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand All @@ -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. |
Expand All @@ -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. |
Expand All @@ -81,15 +81,15 @@ 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. |

## 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. |
Expand Down
Loading
Loading