_{Lidarr Tools | Downloader | Data Server}

Introduction

Limbo is a set of tools and a downloader for Lidarr music manager. It contains a full MusicBrainz mirror server with automated installation. When the Limbo Stick helper is installed next to Lidarr, many settings are auto-discovered, so you don't need to set any URLs, API keys or ports. You can start using Limbo right away.

Currently implemented features:

• Library Statistics
• Release blocking (block specific media formats: vinyl, tape, etc.)
• Release / Artist refreshing (paste URL/ID single/bulk and refresh albums/artists)
• Artist Photos, Cover Art + Data providers selection, with drag & drop precedence
• Lidarr control API - start/stop/restart/update Lidarr, cancel/pause scheduler tasks
• Lidarr Theme system with over 30 themes (Theme.Park and Community)
• SMB network browser and volume auto mounting - no env files to edit

Features in testing:

• Automated / Manual Downloads - built-in downloader or use your own external client (SLSKD)
• Manual bulk importing
• Release / Album splitting - manage and download Original and Deluxe, Anniversary (etc.) releases
• One-shot bulk artwork search with direct Lidarr installation
• CSV / JSON Lidarr data export and custom reporting

Other features are currently in development or testing. Update notifications are displayed at the bottom of the Limbo WebUI.

Requirements

• Unraid or Linux server or VM or LXC with Docker
• Minimum 300-500 GB of available storage
  • Additional storage for optional downloading and music sharing
• Minimum 8 GB of memory available to the container
• 2-4 hours installation time

Quick Start

1. Preparation

Register for MusicBrainz access & token

• Create an account at https://MusicBrainz.com
• Get your Live Data Feed Access Token from Metabrainz https://metabrainz.org/profile

Linux Host / CLI / Shell

• Make sure you have curl and screen (or tmux) installed on your host

Unraid

• Install the Compose Manager Plus plugin from Community Apps
• You will now see a Compose tab on the Docker page

2. Download the Limbo compose files (no git required)

Linux Host / CLI / Shell

Create a folder and download the latest compose.yaml and example.env from the Limbo release assets (or the raw files in this repo).

mkdir -p /opt/docker/limbo
cd /opt/docker/limbo
curl -fsSL -o limbo-latest.zip https://github.com/HVR88/Limbo/releases/latest/download/limbo-latest.zip
unzip -o limbo-latest.zip

Unraid

Open the GitHub page https://github.com/HVR88/Limbo and go to step 3.

3. Copy and configure env file

Linux Host / CLI / Shell

Copy example.env to .env, and edit the top section before first run:

cp example.env .env

Configure this variable in the .env file:

• Set MUSICBRAINZ_REPLICATION_TOKEN (get yours from https://metabrainz.org/profile)

Unraid

Copy the text of compose.yaml and example.env directly from the GitHub Repo and paste the contents into their respective tabs, making sure to add the MusicBrainz token, then SAVE.

4. Download containers, build DB & start up (!) This takes 2-4 hours

Linux Host / CLI / Shell

Tip

Use screen or tmux so the installation can continue running if the terminal session drops, window closes, computer goes to sleep, etc.

screen -S limbo-install

docker compose pull
docker compose up -d

Now type ctrl-a and then d to detach from the screen session.

Close the terminal and monitor progress from Limbo: http://LIMBO_HOST_IP:4808

Unraid

Click Limbo icon in Compose Manager and select Compose Up, check the Run in Background box, and press the Compose Up button.

You can monitor progress from your web browser in Limbo: http://LIMBO_HOST_IP:4808

5. Install Limbo Stick next to Lidarr

While Limbo itself can be installed on any host and doesn't need to be next to Lidarr, the special Limbo Stick container does. It's a helper that allows Limbo direct control over Lidarr's environment, to add theme support, built-in download buttons and the ability to start/stop/pause tasks.

Linux Host / CLI / Shell

Install the Limbo Stick container next to Lidarr.

mkdir -p /opt/docker/limbo-stick
cd /opt/docker/limbo-stick
curl -fsSL -o limbostick-latest.zip https://github.com/HVR88/Limbo/releases/latest/download/limbostick-latest.zip
unzip -o limbostick-latest.zip

docker compose pull
docker compose up -d

Unraid

The same process as with Limbo. Copy the text of of the Limbo Stick compose.yaml and example.env directly from the GitHub Repo to the correct tabs in Compose Manager Plus, then save. Make sure this is the same host/docker network as Lidarr.

Click the Limbo Stick Icon and select Compose Up, Run in Background, and click the Compose Up Button.

6. Finishing

When Limbo installation and database indexes are complete, you'll see the message "Install complete" along with a yellow confirmation button. Press the button to finish, which will unlock the rest of the UI.

Browser Access

• Limbo: http://LIMBO_HOST_IP:4808

• Lidarr with UI Extras: http://LIDARR_HOST_IP:4811

• Limbo Stick Status: http://LIDARR_HOST_IP:4810

• Local MusicBrainz web site: http://LIMBO_HOST_IP:4820
  (Off by default, enable it in Limbo General Settings)

Tip

Put a reverse proxy (NPM, Caddy, Traefik, SWAG) in front of your host IP and use your own domain to reach Limbo and MusicBrainz locally on port 80 (HTTP) or 443 (HTTPS) example: limbo.domain.net and mbrainz.domain.net

Updating

For Limbo:

Linux Host / CLI / Shell

Pull the latest images and restart two times (the first time installs updated compose file, second time uses the updatec file to put up the containers):

docker compose pull
docker compose up -d
docker compose up -d

If you have any issues with stale containers, then do this instead:

sudo docker compose pull
sudo docker compose up -d
sudo docker compose pull
sudo docker compose up -d --remove-orphans --force-recreate

The .env file is user-maintained and won't be changed when updating. Updating will refresh all other managed files automatically: admin scripts, compose template, and defaults, including example.env.

You should look in the example.env file for any changes that may need to be applied to .env - if there are new required variables, you should get a warning on the second compose up.

These files are automatically updated on every docker compose up

• compose.yaml
• example.env
• README.md

Unraid

Click the Limbo icon and select Force Update

For Limbo Stick:

Linux Host / CLI / Shell

The same procedure as the initial installation ensures you have an up-to-date compose.yaml file.

cd /opt/docker/limbo-stick
curl -fsSL -o limbostick-latest.zip https://github.com/HVR88/Limbo/releases/latest/download/limbostick-latest.zip
unzip -o limbostick-latest.zip

docker compose pull
docker compose up -d

Unraid

Click the Limbo Stick icon and select Force Update

Limbo Configuration

Go to http://<LIMBO_HOST_IP>:4808

Use the SETTINGS button on the top right of the webUI to access all of Limbo's settings. If you've installed Limbo Stick, Lidarr configuration is auto-discovered. Otherwise, configure your Lidarr IP:PORT and API KEY. The API Key can be found in Lidarr's Settings -> General page

Notes

• Continued (scheduled) replication and indexing is required to keep the database up-to-date and at optimal performance - this is already active by default
• This stack is configured for private use on a LAN, behind a firewall, IT'S NOT SECURED FOR THE OPEN INTERNET

Maintenance

Keep database scheduled tasks and mainenance options enabled in Limbo Settings.

Additional helper scripts are synced into admin/ automatically when the stack starts or updates:

• admin/status (show container status)
• admin/logs [services...] (follow logs)
• admin/restart [services...] (restart services)
• admin/replicate-now (trigger replication immediately)
• admin/reindex-now (trigger search reindex)
• admin/bootstrap-reset (clear bootstrap markers; prompts for confirmation)