arch-koel

Application

Koel

Description

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.

Build notes

Latest GitHub release of Koel.

Usage

docker run -d \
    -p 8050:8050 \
    -p 8060:8060 \
    --name=<container name> \
    -v <path for media files>:/media \
    -v <path for config files>:/config \
    -v /etc/localtime:/etc/localtime:ro \
    -e PHP_MEMORY_LIMIT=<value in megabytes> \
    -e FASTCGI_READ_TIMEOUT=<timeout value in seconds> \
    -e UMASK=<umask for created files> \
    -e PUID=<uid for user> \
    -e PGID=<gid for user> \
    binhex/arch-koel

Please replace all user variables in the above command defined by <> with the correct values.

Access application

http://<host ip>:8050

or

https://<host ip>:8060

The default username for the web ui is "admin@example.com", password is "admin"

Example

docker run -d \
    -p 8050:8050 \
    -p 8060:8060 \
    --name=koel \
    -v /media/music:/media \
    -v /apps/docker/koel/config:/config \
    -v /etc/localtime:/etc/localtime:ro \
    -e PHP_MEMORY_LIMIT=2048 \
    -e FASTCGI_READ_TIMEOUT=6000 \
    -e UMASK=000 \
    -e PUID=0 \
    -e PGID=0 \
    binhex/arch-koel

Notes

User ID (PUID) and Group ID (PGID) can be found by issuing the following command for the user you want to run the container as:-

id <username>

If your music collection is large you may have to increase the value for PHP_MEMORY_LIMIT (default value 2048 MB) and FASTCGI_READ_TIMEOUT (default value 6000 secs) in order to prevent running out of memory and/or timing out during the initial library scan.

If you appreciate my work, then please consider buying me a beer :D

Support forum