In order to tell the container where your media is located, we can simply edit both the /path/to/config and /path/to/music in the container.

Docker Run

docker run -d \
  --name parsonlabs-music \
  -p 1993:1993 \
  -v "/path/to/config:/ParsonLabsMusic" \
  -v "/path/to/music:/music" \
  --restart unless-stopped \
  ghcr.io/willkirkmanm/music

That's all! Once the container starts, you will see running on port 1993.

Docker Compose

In the root of the repository, you will see two files, docker-compose.yml and docker-compose-local.yml, these are used to deploy Music.

Editing docker-compose.yml

services:
  music-server:
    image: ghcr.io/willkirkmanm/music
    container_name: parsonlabs-music
    ports:
      - "1993:1993"
    volumes:
      - "/path/to/config:/ParsonLabsMusic"
      - "/path/to/music:/music"
    restart: unless-stopped

services:
  music-server:
    build:
      context: .
      dockerfile: Dockerfile
    container_name: parsonlabs-music
    ports:
      - "1993:1993"
    volumes:
      - "/path/to/config:/ParsonLabsMusic"
      - "/path/to/music:/music"
    restart: unless-stopped

Starting music in docker-compose

To start music, when the volumes and environment variables have been set, run the command:

docker-compose up -d

If you would like to use the docker-compose-local.yml file, run this command which specifies the docker-compose-local.yml file.

docker-compose -f docker-compose-local.yml up -d

This will start ParsonLabs Music in a daemon

Deploying with Podman

To deploy ParsonLabs Music using Podman, you can follow similar steps to Docker. Here’s how you can do it:

Podman Run

podman run -d \
  --name parsonlabs-music \
  -p 1993:1993 \
  -v "/path/to/config:/ParsonLabsMusic" \
  -v "/path/to/music:/music" \
  --restart unless-stopped \
  ghcr.io/willkirkmanm/music

Podman Compose

If you prefer to use a compose file, you can use podman-compose with the same or files. Here’s how you can do it:

Using

podman-compose -f docker-compose.yml up -d

Using

podman-compose -f docker-compose-local.yml up -d

Changing Ports

Changing Port Mappings

If you need to change the port mappings, you can do so by changing the docker running scripts. For example, to change the external port from 1993 to 9000, you would update the port mapping as follows:

services:
  music-server:
    ...
    ports:
      - "9000:1993"
    ...

Environment variables

JWT Secret

The JWT Secret is used in authentication to sign and verify the JWT's that are recieved in the server are legitimate. Although Music randomly generates a JWT Secret everytime the server is restarted, it is possible to assign a custom secret through the environment variable JWT_SECRET=.

For example, for Docker run through adding the -e JWT_SECRET="your_super_secure_secret":

docker run -d \
  --name parsonlabs-music \
  ...
  -e JWT_SECRET="your_super_secure_secret" \
  --restart unless-stopped \
  ghcr.io/willkirkmanm/music

Similarly for docker-compose:

version: '3.8'
 
services:
  music-server:
    ...
    environment:
      JWT_SECRET: "your_super_secure_secret"
    ...