Skip to content

daemonless/stump

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Stump

Build Status Last Commit

A free and open source comics, manga and digital book server with OPDS support.

Port 10801
Registry ghcr.io/daemonless/stump
Source https://github.com/stumpapp/stump
Website https://stumpapp.dev

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users. Matches Linux Docker behavior.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

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)
    volumes:
      - "/path/to/containers/stump:/config"
      - "/path/to/containers/stump/data:/data" # optional
    ports:
      - "10801:10801"
    restart: unless-stopped

AppJail Director

.env:

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

appjail-director.yml:

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  stump:
    name: stump
    options:
      - container: 'boot args:--pull'
      - expose="10801:10801 proto:tcp" \
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - stump: /config
      - stump_data: /data
volumes:
  stump:
    device: '/path/to/containers/stump'
  stump_data:
    device: '/path/to/containers/stump/data'

Makejail:

ARG tag=latest

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

Note: 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 IPv4 address assigned by the virtual network.

Podman CLI

podman run -d --name stump \
  -p 10801:10801 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -v /path/to/containers/stump:/config \
  -v /path/to/containers/stump/data:/data # optional \
  ghcr.io/daemonless/stump:latest

AppJail

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="10801:10801 proto:tcp" \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -o fstab="/path/to/containers/stump /config <pseudofs>" \
  -o fstab="/path/to/containers/stump/data /data <pseudofs>" \ # optional
  ghcr.io/daemonless/stump:latest stump

Note: 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 IPv4 address assigned by the virtual network.

Ansible

- name: Deploy stump
  containers.podman.podman_container:
    name: stump
    image: "ghcr.io/daemonless/stump:latest"
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
    ports:
      - "10801:10801"
    volumes:
      - "/path/to/containers/stump:/config"
      - "/path/to/containers/stump/data:/data" # optional

Access at: http://localhost:10801

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)

Volumes

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

Ports

Port Protocol Description
10801 TCP Web UI

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.1


Need help? Join our Discord community.

About

A free and open source comics, manga and digital book server with OPDS support.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors