preparations for release

README.md

@@ -26,6 +26,14 @@ Explo offers two discovery modes:
 
 ### Installation
 
+#### Docker
+
+1. Download [docker-compose.yaml](https://github.com/LumePart/Explo/blob/main/docker-compose.yaml) file to your system and configure volume mappings
+2. Make a ``local.env`` file in the same directory and configure it ([refer to sample.env](https://github.com/LumePart/Explo/blob/main/sample.env) for options)
+3. Launch the container with `docker compose up -d`
+
+#### Binary
+
 1. Download the [latest release](https://github.com/LumePart/Explo/releases/latest) and ensure it's executable
 2. Make a ``local.env`` file in the same directory and configure it ([refer to sample.env](https://github.com/LumePart/Explo/blob/main/sample.env) for options)
 3. Add a Cron job to run Explo weekly:
@@ -34,7 +42,7 @@ crontab -e
 ```
 Insert this to the last line to execute Explo every tuesday at 00:15 (ListenBrainz updates its discovery database on Mondays)
 ```bash
-15 0 * * 2 cd /path/to/explo && ./explo-amd64-linux
+15 0 * * 2 cd /path/to/explo && ./explo-linux-amd64
 ```
 **PS!** To test if everything is correct change ``LISTENBRAINZ_DISCOVERY`` to ``test`` and run the program manually
 

docker-compose.yaml

@@ -4,6 +4,7 @@ services:
     container_name: explo
     volumes:
       - /path/to/local.env:/opt/explo/local.env
-      - /path/to/musiclibrary/explo:/download/dir # should be in the same path you have your music system pointed to, download/dir same as in local.env
+      - /path/to/musiclibrary/explo:DOWNLOAD_DIR # Should be in the same path you have your music system pointed to, DOWNLOAD_DIR has to be same as in local.env
+      # - /path/to/playlist:/path/to/playlists # for MPD. Should be 1:1 with PLAYLIST_DIR in local.env (e.g /mpd/playlists:/mpd/playlists) 
     environment:
       - CRON_SCHEDULE=15 00 * * 2 # Runs weekly, every Tuesday 15 minutes past midnight