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

Update README.md

Browse Source 
Updating visuals - TBC
This commit is contained in:
Jamie Miller
2025-09-22 00:30:33 +12:00
parent 639a2e4c2a
commit 57e67ff2e8
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -5,6 +5,7 @@ This project provides a simple API service that syncs your listening history fro
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. 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 ✨ Features
Automatic Synchronization: Fetches and updates the list of artists from your Maloja instance every hour. 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. MusicBrainz Integration: Resolves artist IDs even when a MusicBrainz ID for a track isn't available.
@@ -12,6 +13,7 @@ MusicBrainz Integration: Resolves artist IDs even when a MusicBrainz ID for a tr
Docker-Ready: Packaged as a lightweight Docker image for easy deployment. Docker-Ready: Packaged as a lightweight Docker image for easy deployment.
📦 Prerequisites 📦 Prerequisites
Docker and Docker Compose Docker and Docker Compose
A Maloja instance with API access enabled A Maloja instance with API access enabled
@@ -24,6 +26,7 @@ Bash
git clone https://gitea.kansaigaijin.com/kansaigaijin/Majola-Lidarr-Importer.git git clone https://gitea.kansaigaijin.com/kansaigaijin/Majola-Lidarr-Importer.git
cd Majola-Lidarr-Importer cd Majola-Lidarr-Importer
2. Configure Environment Variables 2. Configure Environment Variables
Copy the provided .env.template file to a new file named .env and fill in your Maloja API details. Copy the provided .env.template file to a new file named .env and fill in your Maloja API details.
@@ -35,9 +38,13 @@ Open the .env file with a text editor and enter your specific values.
Ini, TOML Ini, TOML
# Maloja API details # Maloja API details
# Get these from your Maloja instance settings # Get these from your Maloja instance settings
SOURCE_API_URL=https://<your-maloja-url>/apis/mlj_1/scrobbles SOURCE_API_URL=https://<your-maloja-url>/apis/mlj_1/scrobbles
SOURCE_API_KEY=<your_api_key> SOURCE_API_KEY=<your_api_key>
3. Run with Docker Compose 3. Run with Docker Compose
To start the service, simply run the following command in the project's root directory: To start the service, simply run the following command in the project's root directory:
@@ -47,6 +54,7 @@ docker-compose up -d
This command will pull the pre-built Docker image and start the container in the background. This command will pull the pre-built Docker image and start the container in the background.
🎶 Lidarr Setup 🎶 Lidarr Setup
In Lidarr, navigate to Settings -> Import Lists. In Lidarr, navigate to Settings -> Import Lists.
Click the + button to add a new list. Click the + button to add a new list.
@@ -59,7 +67,7 @@ Name: Maloja List (or a name of your choice)
Tags: (Optional, add a tag like maloja) Tags: (Optional, add a tag like maloja)
Url: http://maloja-lidarr-importer-api:5000/artists Url: http://localhost:5000/artists
Minimum Time: 60 Minutes (or more) Minimum Time: 60 Minutes (or more)