alexphillips/koel repository overview

⁠Contact information

The LinuxServer.io⁠ team brings you another image release featuring easy user mapping and based on alpine linux with s6 overlay.

⁠alexphillips/koel

Koel (also stylized as koel, with a lowercase k) is a simple web-based personal audio streaming service written in Vue on the client side and Laravel on the server side. Targeting web developers, Koel embraces some of the more modern web technologies – flexbox, audio, and drag-and-drop API to name a few – to do its job.

⁠Usage

docker create \
  --name=koel \
  -v <path to data>:/config \
  -e PGID=<gid> -e PUID=<uid>  \
  -e DB_CONNECTION=<DB_CONNECTION> \
  -e DB_HOST=<DB_HOST> \
  -e DB_DATABASE=<DB_DATABASE> \
  -e DB_USERNAME=<DB_USERNAME> \
  -e DB_PASSWORD=<DB_PASSWORD> \
  -e ADMIN_EMAIL=<ADMIN_EMAIL> \
  -e ADMIN_NAME=<ADMIN_NAME> \
  -e ADMIN_PASSWORD=<ADMIN_PASSWORD> \
  -p 8000:80 \
  alexphillips/koel

⁠Parameters

The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.

⁠User / Group Identifiers

Sometimes when using volumes (-v flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and it will "just work" ™.

In this instance PUID=1001 and PGID=1001, to find yours use id user as below:

  $ id <dockeruser>
    uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)

⁠Setting up the application

Access the WebUI at :80. For more information, check out Koel⁠.

⁠Container access and information.

⁠Versions