update docs & tests

Author: AEnterprise

Dockerfile

@@ -105,13 +105,14 @@ RUN curl -L https://github.com/koel/koel/releases/download/${KOEL_VERSION_REF}/k
   && rm -rf /tmp/*
 
 
-# Install x-sendfile for apache2
+# Install x-sendfile for apache2, fix home folder
 USER root
-RUN apk add --no-cache apache2-dev gcc musl-dev \
+RUN apk add --no-cache apache2-dev gcc musl-dev shadow \
   && curl -o mod_xsendfile.c https://tn123.org/mod_xsendfile/mod_xsendfile.c \
   && apxs -cia mod_xsendfile.c \
   && rm mod_xsendfile.* \
-  && apk del --no-cache apache2-dev gcc musl-dev \
+  && usermod -d /var/www/
+  && apk del --no-cache apache2-dev gcc musl-dev shadow\
   && mkdir /var/www/lib \
   && ln -s /usr/lib/apache2 /var/www/lib/apache2
 
@@ -181,7 +182,7 @@ CMD [""]
 EXPOSE 80
 
 # Check that the homepage is displayed
-HEALTHCHECK --start-period=100m --interval=5m --timeout=5s \
+HEALTHCHECK --start-period=30s --interval=5m --timeout=5s \
   CMD curl -f http://localhost/sw.js || exit 1
 
 

README.md

@@ -41,13 +41,15 @@ docker-compose -f ./docker-compose.postgres.yml up -d
 
 ## The `koel:init` command
 
+This command is automatically ran when the container starts, but can be disabled if you want to do some manual adjustments first. As such it is often sufficient to provide the needed env variables to the container to setup koel.
+
 For the first installation and every subsequent upgrade, you will need to run the `koel:init` command, which handles migrations and other setup tasks.
 For instance, during the first run, this command will generate the `APP_KEY`, create the default admin user, and initialize the database. For subsequent runs, it will apply any new migrations and update the database schema as needed.
 
 In order to run this command, you first need to `exec` into the container (replace `<container_name_for_koel>` with the name of your running Koel container):
 
 ```bash
-docker exec --user www-data -it <container_name_for_koel> bash
+docker exec --user www-data -it <container_name_for_koel> sh
 ```
 
 Once inside the container, run the `koel:init` command:
@@ -142,7 +144,7 @@ Once you have generated an `APP_KEY` you can provide it as environment variables
 
 ```bash
 # Run a container just to generate the key
-docker run -it --rm phanan/koel bash
+docker run -it --rm phanan/koel sh
 # In the container, generate APP_KEY
 $ php artisan key:generate --force
 # Show the modified .env file
@@ -188,7 +190,7 @@ For all new songs, the search index will be automatically populated by `php arti
 
 > [!IMPORTANT]
 > This list is not exhaustive and may not be up-to-date. See [`.env.example`][koel-env-example] for a complete reference.
-
+- `SKIP_INIT` : set a value to prevent the container from automatically running the init script on startup
 - `DB_CONNECTION`: `mysql` OR `pgsql` OR `sqlsrv` OR `sqlite-persistent`. Corresponds to the type of database being used with Koel.
 - `DB_HOST`: `database`. The name of the Docker container hosting the database. Koel needs to be on the same Docker network to find the database by its name.
 - `DB_USERNAME`: `koel`. If you change it, also change it in the database container.
@@ -199,6 +201,7 @@ For all new songs, the search index will be automatically populated by `php arti
 - `MEMORY_LIMIT`: The amount of memory in MB for the scanning process. Increase this value if `php artisan koel:scan` runs out of memory.
 - `LASTFM_API_KEY` and `LASTFM_API_SECRET`: Enables Last.fm integration. See https://docs.koel.dev/3rd-party.html#last-fm
 - `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET`: Enables Spotify integration. See https://docs.koel.dev/3rd-party.html#spotify
+- `OPTIMIZE_CONFIG` Preload and optimize the config. This disables your ability to do config edits while the container is running. If you enable this every config change will require a container restart to apply.
 
 ## Volumes
 

goss.yaml

@@ -87,41 +87,35 @@ file:
 package:
   ffmpeg:
     installed: true
-  libapache2-mod-xsendfile:
-    installed: true
 port:
   tcp:80:
     listening: true
     ip:
     - 0.0.0.0
-service:
-  apache2:
-    enabled: true
-    skip: false
-    running: true
+  tcp:9000:
+    listening: true
+    ip:
+    - 127.0.0.1
 user:
   www-data:
     exists: true
-    uid: 33
-    gid: 33
+    uid: 102
+    gid: 82
     groups:
     - www-data
     home: /var/www
-    shell: /usr/sbin/nologin
+    shell: /sbin/nologin
 group:
   www-data:
     exists: true
-    gid: 33
+    gid: 82
 command:
   artisan_env:
-    exec: php artisan env
+    exec: php /var/www/html/artisan env
     exit-status: 0
     stdout: ['/production/']
     stderr: []
     timeout: 0
-process:
-  apache2:
-    running: true
 http:
   http://localhost/sw.js:
     status: 200