Preserve search indexes from v5.0.2 in a volume

How to test:
- Run the dev stack:
  $ make start
- Copy songs in the /music volume. Sync them:
  $ make sync-music
- Remove the dev stack containers:
  $ docker-compose -f docker-compose.dev.yml down
- Recreate the dev stack
  $ make start
- In the web UI, search for a song, album or artist. You should find
some results. Before this commit, you would not find results, as the
search indexes would be reset.

Author: Hyzual

Dockerfile

@@ -75,11 +75,11 @@ RUN a2enmod rewrite
 # Copy the downloaded release
 COPY --from=release-downloader --chown=www-data:www-data /tmp/koel /var/www/html
 
-# Music volume
-# This needs to be AFTER creating the folders and setting their permissions
+# Volumes for the music files and search index
+# This declaration must be AFTER creating the folders and setting their permissions
 # and AFTER changing to non-root user.
 # Otherwise, they are owned by root and the user cannot write to them.
-VOLUME ["/music"]
+VOLUME ["/music", "/var/www/html/storage/search-indexes"]
 
 ENV FFMPEG_PATH=/usr/bin/ffmpeg \
     MEDIA_PATH=/music \

Makefile

@@ -1,4 +1,4 @@
-.PHONY: all help start setup
+.PHONY: all help start
 
 all: help
 
@@ -8,7 +8,7 @@ build-docker-image: ## Builds the production x86_64 Docker image
 build-all-arch-docker-images: ## Builds the production Docker image for all supported processor architectures
 	docker buildx build --platform linux/amd64,linux/arm/v7,linux/arm64 . --file Dockerfile --tag hyzual/koel-dev:latest
 
-setup: ## Init the DEV docker-compose stack
+koel-init: ## Create the APP_KEY for the DEV docker-compose stack
 	docker exec -it koeldev php artisan koel:init
 
 sync-music: ## Sync music from the /music volume with the database

README.md

@@ -81,6 +81,7 @@ docker run -d --name koel \
     --network=koel-net \
     -v music:/music \
     -v covers:/var/www/html/public/img/covers \
+    -v search_index:/var/www/html/storage/search-indexes \
     hyzual/koel
 ```
 
@@ -140,6 +141,16 @@ Whenever the music in `/music` changes, you will need to manually scan it before
 docker exec koel php artisan koel:sync
 ```
 
+### Populate the search indexes
+
+If you were running a version of Koel prior to v5.0.2, the search mechanism has changed and needs a step to index songs, albums and artists. Run the following command:
+
+```bash
+docker exec koel php artisan koel:search:import
+```
+
+For all new songs, the search index will be automatically populated by `php artisan koel:sync`. No need to run the `php artisan koel:search:import` again :).
+
 ## Useful environment variables
 
 See [`.env.example`][koel-env-example] for reference.
@@ -158,8 +169,11 @@ See [`.env.example`][koel-env-example] for reference.
 
 ### /music
 
-`/music` will contain the music library. Keep in mind that koel needs to
-scan music before it's able to play it.
+`/music` will contain the music library. Keep in mind that koel needs to scan music before it's able to play it.
+
+### /var/www/html/storage/search-indexes
+
+`/var/www/html/storage/search-indexes` will contain the search indexes. Searching songs, albums and artists leverages this to provide results.
 
 ## Ports
 

docker-compose.dev.yml

@@ -1,4 +1,4 @@
-version: '3.7'
+version: '3'
 
 services:
   koel:
@@ -19,6 +19,7 @@ services:
     volumes:
       - music:/music
       - covers:/var/www/html/public/img/covers
+      - search_index:/var/www/html/storage/search-indexes
       - ./.env.koel:/var/www/html/.env
 
   database:
@@ -35,3 +36,4 @@ volumes:
   db:
   music:
   covers:
+  search_index:

docker-compose.yml

@@ -1,4 +1,4 @@
-version: '3.7'
+version: '3'
 
 services:
   koel:
@@ -16,6 +16,7 @@ services:
     volumes:
       - music:/music
       - covers:/var/www/html/public/img/covers
+      - search_index:/var/www/html/storage/search-indexes
 
   database:
     image: mysql/mysql-server:5.7
@@ -34,3 +35,5 @@ volumes:
     driver: local
   covers:
     driver: local
+  search_index:
+    driver: local

goss.yaml

@@ -107,6 +107,13 @@ file:
     group: www-data
     filetype: directory
     contains: []
+  /var/www/html/storage/search-indexes:
+    exists: true
+    mode: "0755"
+    owner: www-data
+    group: www-data
+    filetype: directory
+    contains: []
   /var/www/html/tests:
     exists: false
     contains: []