KansaiGaijin/Majola-Lidarr-Importer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Prettified the README

Browse Source
This commit is contained in:
Jamie Miller
2025-09-21 12:27:30 +00:00
parent 4f596ffefe
commit 639a2e4c2a
1 changed files with 70 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

140
README.md
View File

@@ -1,71 +1,71 @@
Maloja-Lidarr Importer
🎯 Overview
This project provides a simple API service that syncs your listening history from a self-hosted Maloja instance to a Lidarr custom import list.
Lidarr's custom import feature requires a JSON list of MusicBrainz Artist IDs. This service automatically fetches your unique artists from Maloja and serves them in the correct format, allowing Lidarr to add new artists to your library automatically.
✨ Features
Automatic Synchronization: Fetches and updates the list of artists from your Maloja instance every hour.
MusicBrainz Integration: Resolves artist IDs even when a MusicBrainz ID for a track isn't available.
Docker-Ready: Packaged as a lightweight Docker image for easy deployment.
📦 Prerequisites
Docker and Docker Compose
A Maloja instance with API access enabled
A Lidarr instance
🚀 Getting Started
1. Clone the Repository
Bash
git clone https://gitea.kansaigaijin.com/kansaigaijin/Majola-Lidarr-Importer.git
cd Majola-Lidarr-Importer
2. Configure Environment Variables
Copy the provided .env.template file to a new file named .env and fill in your Maloja API details.
Bash
cp .env.template .env
Open the .env file with a text editor and enter your specific values.
Ini, TOML
# Maloja API details
# Get these from your Maloja instance settings
SOURCE_API_URL=https://<your-maloja-url>/apis/mlj_1/scrobbles
SOURCE_API_KEY=<your_api_key>
3. Run with Docker Compose
To start the service, simply run the following command in the project's root directory:
Bash
docker-compose up -d
This command will pull the pre-built Docker image and start the container in the background.
🎶 Lidarr Setup
In Lidarr, navigate to Settings -> Import Lists.
Click the + button to add a new list.
Select Custom from the list of providers.
Configure the settings as follows:
Name: Maloja List (or a name of your choice)
Tags: (Optional, add a tag like maloja)
Url: http://maloja-lidarr-importer-api:5000/artists
Minimum Time: 60 Minutes (or more)
Password: (Leave blank)
This URL uses Docker's internal networking to allow Lidarr to communicate directly with the API container, bypassing any external authentication proxies or firewalls.
📄 License
Maloja-Lidarr Importer
🎯 Overview
This project provides a simple API service that syncs your listening history from a self-hosted Maloja instance to a Lidarr custom import list.
Lidarr's custom import feature requires a JSON list of MusicBrainz Artist IDs. This service automatically fetches your unique artists from Maloja and serves them in the correct format, allowing Lidarr to add new artists to your library automatically.
✨ Features
Automatic Synchronization: Fetches and updates the list of artists from your Maloja instance every hour.
MusicBrainz Integration: Resolves artist IDs even when a MusicBrainz ID for a track isn't available.
Docker-Ready: Packaged as a lightweight Docker image for easy deployment.
📦 Prerequisites
Docker and Docker Compose
A Maloja instance with API access enabled
A Lidarr instance
🚀 Getting Started
1. Clone the Repository
Bash
git clone https://gitea.kansaigaijin.com/kansaigaijin/Majola-Lidarr-Importer.git
cd Majola-Lidarr-Importer
2. Configure Environment Variables
Copy the provided .env.template file to a new file named .env and fill in your Maloja API details.
Bash
cp .env.template .env
Open the .env file with a text editor and enter your specific values.
Ini, TOML
# Maloja API details
# Get these from your Maloja instance settings
SOURCE_API_URL=https://<your-maloja-url>/apis/mlj_1/scrobbles
SOURCE_API_KEY=<your_api_key>
3. Run with Docker Compose
To start the service, simply run the following command in the project's root directory:
Bash
docker-compose up -d
This command will pull the pre-built Docker image and start the container in the background.
🎶 Lidarr Setup
In Lidarr, navigate to Settings -> Import Lists.
Click the + button to add a new list.
Select Custom from the list of providers.
Configure the settings as follows:
Name: Maloja List (or a name of your choice)
Tags: (Optional, add a tag like maloja)
Url: http://maloja-lidarr-importer-api:5000/artists
Minimum Time: 60 Minutes (or more)
Password: (Leave blank)
This URL uses Docker's internal networking to allow Lidarr to communicate directly with the API container, bypassing any external authentication proxies or firewalls.
📄 License
This project is licensed under the MIT License.