Skip to content

Stump Stump

Description / nameInput element
Container Registry
Container Configuration Root Path
Timezone
User ID
Group ID
Stump Host Port
Stump /config Path
Stump /data Path

Build Status Last Commit OCI Pulls

A free and open source comics, manga and digital book server with OPDS support.
Port 10801
Registry ghcr.io/daemonless/stump
Daemonless daemonless/stump
Source stumpapp/stump
Website stumpapp.dev

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users — recommended.

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
services:
  stump:
    image: "ghcr.io/daemonless/stump:latest"
    container_name: stump
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container (e.g. America/New_York)
      - STUMP_TRUST_PROXY_HEADERS=  # Trust X-Forwarded-* headers from a reverse proxy so image/thumbnail URLs use the correct scheme/host. Uncomment (=true) only when behind a proxy; leave off if the port is exposed directly.
    volumes:
      - "/containers/stump:/config"
      - "/containers/stump/data:/data" # optional
    ports:
      - "10801:10801"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

1
2
3
4
5
6
7
# .env

DIRECTOR_PROJECT=stump
PUID=1000
PGID=1000
TZ=UTC
STUMP_TRUST_PROXY_HEADERS=

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  stump:
    name: stump
    options:
      - container: 'args:--pull'
      - expose: '10801:10801 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - STUMP_TRUST_PROXY_HEADERS: !ENV '${STUMP_TRUST_PROXY_HEADERS}'
    volumes:
      - STUMP_CONFIG_PATH: /config
      - STUMP_DATA_PATH: /data
volumes:
  STUMP_CONFIG_PATH:
    device: '/containers/stump'
  STUMP_DATA_PATH:
    device: '/containers/stump/data'

1
2
3
4
5
6
7
# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/stump:${tag}

Save the files above, then run appjail-director up.

Experimental

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
services:
  stump:
    name: stump
    image: "ghcr.io/daemonless/stump:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - STUMP_TRUST_PROXY_HEADERS=
    volumes:
      - "/containers/stump:/config"
      - "/containers/stump/data:/data"

Save as bastille-compose.yml, then run bastille up.

Access at: http://localhost:10801

Interactive Configuration

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container (e.g. America/New_York)
STUMP_TRUST_PROXY_HEADERS `` Trust X-Forwarded-* headers from a reverse proxy so image/thumbnail URLs use the correct scheme/host. Uncomment (=true) only when behind a proxy; leave off if the port is exposed directly.

Volumes

Path Description
/config Configuration and database directory
/data Media library (comics, manga, books) (Optional)

Ports

Port Protocol Description
10801 TCP Web UI

Implementation Details

  • Architectures: amd64
  • User: bsd (UID/GID set via PUID/PGID). Defaults to 1000:1000.
  • Base: Built on ghcr.io/daemonless/base (FreeBSD 15.1).

Need help? Join our Discord community.