From 57e67ff2e898ce108944431cdc89d5bc1cc7bfd6 Mon Sep 17 00:00:00 2001 From: Jamie Miller Date: Mon, 22 Sep 2025 00:30:33 +1200 Subject: [PATCH] Update README.md Updating visuals - TBC --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 18a36d1..e29f8bd 100644 --- a/README.md +++ b/README.md @@ -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. ✨ 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. @@ -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. 📦 Prerequisites + Docker and Docker Compose A Maloja instance with API access enabled @@ -24,6 +26,7 @@ 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. @@ -35,9 +38,13 @@ 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:///apis/mlj_1/scrobbles + SOURCE_API_KEY= + 3. Run with Docker Compose 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. 🎶 Lidarr Setup + In Lidarr, navigate to Settings -> Import Lists. 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) -Url: http://maloja-lidarr-importer-api:5000/artists +Url: http://localhost:5000/artists Minimum Time: 60 Minutes (or more)