InstallationDocker

Docker

You have two options for spinning up a container based on your preference:

  1. Docker CLI
  2. Docker Compose

Please ensure to adjust PUID and PGID to the user your config and data directories belong to. You can print those by executing:

echo -e "PUID=$(id -u)\nPGID=$(id -g)"
☢️

This tutorial uses the newer docker compose CLI. If you find this command does not exist for you, you might be on V1, which uses docker-compose. Please review Docker’s documentation for more information and/or platform-specific installation.

Create a docker-compose.yml file

Below is an example of a Docker Compose file you can use to bootstrap your Stump server:

services:
  stump:
    image: aaronleopold/stump:latest
    container_name: stump
    # Replace my paths (prior to the colons) with your own
    volumes:
      - /home/aaronleopold/.stump:/config
      - /media/books:/data
    ports:
      - 10801:10801
    environment:
      - PUID=1000
      - PGID=1000
      # This `environment` field is optional, remove if you don't need it.
      # I am using it as an example here, but it's actually a default value.
      - STUMP_CONFIG_DIR=/config
    restart: unless-stopped

Start the container

docker compose up -d

Update the container

When a new image is available, you can update your container using these commands:

docker compose pull stump
docker compose up -d

Monitoring

To monitor the logs of the container, you can use the following command:

docker logs -f stump
Executable