Skip to content
Klutch.sh Docs

Deploying Stump

Introduction

Stump is a free and open-source comic, manga, and book server designed for speed and simplicity. Built with Rust on the backend and React on the frontend, Stump provides a modern, responsive interface for organizing and reading your digital library from any device.

Key highlights of Stump:

  • Fast Performance: Written in Rust for blazing fast library scanning and serving
  • Modern Web Reader: Built-in reader with customizable reading modes
  • OPDS Support: Access your library from OPDS-compatible apps like Panels, Chunky, and Moon+ Reader
  • Multiple Formats: Supports CBZ, CBR, PDF, EPUB, and image directories
  • Library Organization: Automatic series detection and metadata extraction
  • Reading Progress: Track your reading progress across devices
  • Multi-User Support: Create accounts with different permission levels
  • Smart Collections: Create dynamic collections based on metadata
  • Lightweight: Minimal resource footprint compared to alternatives

This guide walks through deploying Stump on Klutch.sh using Docker.

Why Deploy Stump on Klutch.sh

Deploying Stump on Klutch.sh provides several advantages:

Simplified Deployment: Klutch.sh automatically detects your Dockerfile and builds Stump without complex orchestration.

Persistent Storage: Attach persistent volumes for your comic library and database. Your collection survives container restarts.

HTTPS by Default: Klutch.sh provides automatic SSL certificates for secure access from anywhere.

GitHub Integration: Connect your configuration repository for automatic redeployments.

Prerequisites

Before deploying Stump on Klutch.sh, ensure you have:

  • A Klutch.sh account
  • A GitHub account with a repository for your Stump configuration
  • Basic familiarity with Docker and containerization concepts
  • Your comic/book library files ready to upload

Deploying Stump on Klutch.sh

    Create Your Repository

    Create a new GitHub repository with a Dockerfile for Stump:

    FROM aaronleopold/stump:latest
    

    ENV PUID=1000
    ENV PGID=1000
    ENV STUMP_CONFIG_DIR=/config
    

    EXPOSE 10801
    

    VOLUME ["/books", "/config"]

    Push to GitHub

    Initialize and push your repository to GitHub with your Dockerfile.

    Create a New Project on Klutch.sh

    Navigate to the Klutch.sh dashboard and create a new project.

    Create a New App

    Within your project, create a new app and connect your GitHub repository containing the Stump Dockerfile.

    Configure HTTP Traffic

    In the deployment settings:

    • Select HTTP as the traffic type
    • Set the internal port to 10801

    Set Environment Variables

    Configure the following environment variables:

    VariableValue
    PUID1000
    PGID1000
    STUMP_CONFIG_DIR/config

    Attach Persistent Volumes

    Add the following volumes:

    Mount PathRecommended SizePurpose
    /config5 GBDatabase and configuration
    /books100+ GBYour comic/book library

    Deploy Your Application

    Click Deploy to start the build process.

    Access Stump

    Once deployment completes, access your Stump instance and create your admin account.

Configuration

Adding Your Library

Upload your comics and books to the /books volume. Stump supports:

  • CBZ/CBR: Comic book archives
  • PDF: Digital documents and comics
  • EPUB: E-books
  • Image Folders: Directories of images

OPDS Access

Access your library via OPDS at https://your-stump-url/opds/v1.2/catalog. Configure this URL in your favorite reading app.

Reading Modes

The built-in reader supports:

  • Paged Mode: Traditional page-by-page reading
  • Continuous Scroll: Vertical scrolling for webtoons
  • Double Page: Two-page spreads for larger screens

Additional Resources

Conclusion

Deploying Stump on Klutch.sh gives you a fast, modern comic and book server with automatic builds, persistent storage, and secure HTTPS access. Read your digital library from any device using the web interface or OPDS-compatible apps.