Stump Docs

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)"

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

Docker CLI
Docker Compose

The instructions for both options are provided below

Create the container

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

# replace my paths (left of colon) with your own
docker create \
  --name=stump \
  -e "PUID=1000" \
  -e "PGID=1000" \
  -p 10801:10801 \
  --volume "/home/aaronleopold/.stump:/config" \
  --volume "/media/books:/data" \
  --restart unless-stopped \
  aaronleopold/stump:latest

If you prefer bind mounts, you can swap out the two --volume lines with:

--mount type=volume,source=/home/aaronleopold/.stump,target=/config \
--mount type=volume,source=/media/books,target=/data \

Definitions

Below is a reference for some of the parameters used in this section:

Parameter	Functionality
`--name=stump`	Sets the name of the container this command will create
`-e "PUID=1000" -e "PGID=1000"`	Sets the user and group used within the container (leave this as is)
`-p 10801:10801`	Maps the port on your machine (left) to the port the container uses (right)

Start the container

docker compose up -d

docker start stump

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

docker pull aaronleopold/stump:latest
docker restart stump

Monitoring

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

docker logs -f stump

Docker

Create the container

Definitions

Start the container

Update the container

Monitoring

On this page