Skip to content

Commit

Permalink
docs: update lidarr/plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
bakerboy448 authored and ServarrAdmin committed Jan 19, 2025
1 parent 3a819e4 commit d9ffea6
Showing 1 changed file with 23 additions and 17 deletions.
40 changes: 23 additions & 17 deletions lidarr/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: How Do I Install Plugins
description: Instructions on installing plugins in Lidarr
published: true
date: 2025-01-18T23:47:00.651Z
date: 2025-01-19T00:12:39.421Z
tags: lidarr, plugins
editor: markdown
dateCreated: 2025-01-18T16:05:16.687Z
Expand All @@ -11,26 +11,31 @@ dateCreated: 2025-01-18T16:05:16.687Z
# How Do I Install Plugins

## Plugin Branch

Lidarr plug-ins allow users to extend the capability of Lidarr to include new indexers and download clients, including peer-to-peer networks and common streaming services.

Plug-in capabilities are currently only available on the `plugins` branch.

### Windows
> You cannot go back to a mainline Lidarr branch (master/develop/nightly) without restoring a database prior to the `plugins` branch
{.is-danger}

### Native Installs -Windows, Mac, and Linux

- Navigate to `/settings/general`
- Show Advanced if not already enabled
- Scroll down to Updates. Type in `plugins`
- Save changes.
- Update Lidarr

### Docker

Update your Docker Compose file to use the following image and rebuild.
Update your Docker Compose file to use the following image, pull, and recreate your Lidarr container.

```yaml
image: ghcr.io/hotio/lidarr:pr-plugins
```
Once you have changed branches, navigate to `/system/plugins`. You will have the option to enter the URL of the GitHub repository containing the plugin. Enter the URL and select Install. You can observe the progress in the lower left corner. The installation will take several seconds depending your installation.
- Once you have changed branches, navigate to `/system/plugins`. You will have the option to enter the URL of the GitHub repository containing the plugin. Enter the URL and select Install. You can observe the progress in the lower left corner. The installation will take several seconds depending your installation.

After completing the installation, Lidarr needs to be restarted for the plugin to work properly. The restart procedure varies depending on the platform used.

Expand All @@ -39,28 +44,29 @@ After completing the installation, Lidarr needs to be restarted for the plugin t

## Plugins

Both plugins and this documentation are community-driven. There are no official recommendations at this time, and each plugin is supported by its developer.
> Both plugins and this documentation are community-driven. There are no official recommendations at this time, and each plugin is supported by its developer.
{.is-info}

### codefaux/deemix-for-lidarr

https://github.com/codefaux/deemix-for-lidarr/
[Deemix for Lidarr by Codefaux](https://github.com/codefaux/deemix-for-lidarr/)

### allquiet-hub/Lidarr.Plugin.Slskd

https://github.com/allquiet-hub/Lidarr.Plugin.Slskd
[Slskd (Soulseek) by Allquiet](https://github.com/allquiet-hub/Lidarr.Plugin.Slskd)

#### Prerequisites

This plugin enables Lidarr to search Soulseek using Slskd. You must have a working Lidarr installation from the plugins branch and a working Slskd installation to use this plugin.

To generate the Api Key necessary for the communication to the Slskd app follow the steps here:
https://github.com/slskd/slskd/blob/master/docs/config.md#authentication
To generate the Api Key necessary for the communication to the Slskd app follow the steps [here on the developer's respository](https://github.com/slskd/slskd/blob/master/docs/config.md#authentication)

#### Configuration

##### Download Client

Once the plugin is installed, Slskd can be added as a download client.
- Navigate to `/settings/downloadclients`, and select the plus button under Download clients. Slskd will appear at the bottom under the Other section.
- Navigate to `/settings/downloadclients`, and select the <kb>+</kb> button under Download clients. Slskd will appear at the bottom under the Other section.
- Enter the correct hostname.
- Enter the API key
- Select the Test button.
Expand All @@ -69,7 +75,7 @@ Once the plugin is installed, Slskd can be added as a download client.
#### Indexer

To search, Slskd must also be added as an Indexer.
- Navigate to `/settings/indexers`, and select the plus button under Indexers. Slskd will appear at the bottom under the Other section.
- Navigate to `/settings/indexers`, and select the <kb>+</kb> button under Indexers. Slskd will appear at the bottom under the Other section.
- Enter the correct URL.
- Enter the API key
- Select the Test button.
Expand All @@ -78,25 +84,25 @@ To search, Slskd must also be added as an Indexer.

#### Delay Profile

WIP
WIP - Contributions welcomed

#### Verification

WIP
WIP - Contributions welcomed

### lucapolesel/Lidarr.Plugin.Slskd

https://github.com/lucapolesel/Lidarr.Plugin.Slskd
[Slskd (Soulseek) by lucapolesel](https://github.com/lucapolesel/Lidarr.Plugin.Slskd)

### TrevTV/Lidarr.Plugin.Tidal

https://github.com/TrevTV/Lidarr.Plugin.Tidal
[Tidal by TrevTV](https://github.com/TrevTV/Lidarr.Plugin.Tidal)

### TrevTV/Lidarr.Plugin.Qobuz

https://github.com/TrevTV/Lidarr.Plugin.Qobuz
[Qobuz by TrevTV](https://github.com/TrevTV/Lidarr.Plugin.Qobuz)

### TypNull/Tubifarry

https://github.com/TypNull/Tubifarry
[Tubifarry by TypeNull](https://github.com/TypNull/Tubifarry)

0 comments on commit d9ffea6

Please sign in to comment.