Portainer Templates logo

Portainer Templates

Stump Stump

Container

MediaBooks

A free and open source comics, manga, and digital book server with OPDS support. Source: https://github.com/stumpapp/stump

Image details

Pulls: 882k
Architecture: amd64, arm64, arm64/v8
Image size: 51 MB
Latest: 0.1.6
User: aaronleopold
Created: May 26, 2022
Updated: 2 days ago
Status: active

Source details

Repo: stumpapp/stump
Stars: 3k
Forks: 147
Language: TypeScript
License: MIT
Latest: v0.1.6 · 13 days ago
Updated: 5 hours ago
Website: stumpapp.dev/

Configuration

Type
Container
Platform
linux
Image
aaronleopold/stump:latest
Ports
10801:10801/tcp
Volumes
/config/data
Env vars
PUID=1000PGID=1000STUMP_CONFIG_DIR=/config
Restart
unless-stopped

Standalone Install

Select an install method, to see config/commands for deploying Stump

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Stump, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation, or see stumpapp/stump for app-specific guidance.

Stump's logo. Description: A young individual sitting on a tree stump reading a book. Inspired by Stump's creator's childhood, where a large amount of his time was spent sitting on a tree stump reading his comic books. 

<img src="https://img.shields.io/discord/972593831172272148?label=Discord&color=5865F2" />
<img src="https://img.shields.io/static/v1?label=License&message=MIT&color=CF9977" />
 
<img src="https://img.shields.io/github/package-json/v/aaronleopold/stump?logo=azurepipelines&color=0aa8d2" alt="Current Version">
 
<img src="https://img.shields.io/docker/pulls/aaronleopold/stump?logo=docker&color=0aa8d2&logoColor=fff" alt="Docker Pulls">


Stump is a free and open source comics, manga and digital book server with OPDS support

Getting Started 🚀

For the full setup and getting started instructions, please refer to the documentation or the GitHub.
Stump is still a WIP, so don't expect bug-free experiences here! Please don't use any experimental tags, as they can be less reliable or even functional than nightly

Docker CLI:
# create the container, replace my source paths with your own
docker create \
  --name=stump \
  -e "PUID=1000" \
  -e "PGID=1000" \
  -p 10801:10801 \
  --mount type=bind,source=/Users/aaronleopold/.stump,target=/config \
  --mount type=bind,source=/Users/aaronleopold/Documents/Stump,target=/data \
  --restart unless-stopped \
  aaronleopold/stump

# run the container
docker start stump

If you'd prefer to use Docker Compose, you can create docker-compose.yml file with the following structure:
version: '3.3'
services:
  stump:
    image: aaronleopold/stump
    container_name: stump
    # Replace my paths (prior to the colons) with your own
    volumes:
      - /Users/aaronleopold/.stump:/config
      - /Users/aaronleopold/Documents/Stump:/data
    ports:
      - 10801:10801
    environment:
      - PUID=1000
      - PGID=1000
    restart: unless-stopped

and then run docker-compose up to start the container.

Serve Stump on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying stump.example.com to http://stump:10801

Add this to your Caddyfile

stump.example.com {
	reverse_proxy http://stump:10801
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs stump
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:10801 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :10801
  • Stop the other service, or pick a different host port. In 10801:10801 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:10801. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, stump can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 10801

Image won't pull

Test the pull directly on the host: docker pull aaronleopold/stump:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm64/v8
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect stump --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Stump runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Stump needs bundled into one download. This template pulls aaronleopold/stump:latest, which Docker fetches once (about 51 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Stump's comes from Docker Hub, published by aaronleopold.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 0.1.6. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm64/v8, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 10801:10801 means it's reachable on port 10801 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 10801:10801

Volumes

A volume is where Stump keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config as a volume Docker manages for you
  • /data as a volume Docker manages for you

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Stump takes 3 of them, all with defaults you can leave alone or tweak:

  • PUID, defaults to 1000
  • PGID, defaults to 1000
  • STUMP_CONFIG_DIR, defaults to /config

Restart policy

The restart policy here is unless-stopped, so Docker restarts Stump after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Stump sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container stump. That's what you'll spot in the containers list and use in commands like docker logs stump.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Stump is open source, released under the MIT license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Stump up. Add the template list to Portainer once, then deploying Stump is a click rather than a wall of config.