An open API service indexing awesome lists of open source software.

https://github.com/daemonless/stump


https://github.com/daemonless/stump

Last synced: 12 days ago
JSON representation

Awesome Lists containing this project

README

          

# Stump

[![Build Status](https://img.shields.io/github/actions/workflow/status/daemonless/stump/build.yaml?style=flat-square&label=Build&color=green)](https://github.com/daemonless/stump/actions)
[![Last Commit](https://img.shields.io/github/last-commit/daemonless/stump?style=flat-square&label=Last+Commit&color=blue)](https://github.com/daemonless/stump/commits)

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](https://github.com/stumpapp/stump) |
| **Website** | [https://stumpapp.dev](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](https://daemonless.io/guides/quick-start) for host setup instructions.

## Deployment

### Podman Compose

```yaml
services:
stump:
image: ghcr.io/daemonless/stump:latest
container_name: stump
environment:
- PUID=1000
- PGID=1000
- TZ=UTC
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**:

```yaml
options:
- virtualnet: ': default'
- nat:
services:
stump:
name: stump
options:
- container: 'boot args:--pull'
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}
```

### Podman CLI

```bash
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
```

### Ansible

```yaml
- 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
```

## 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.0

---

Need help? Join our [Discord](https://discord.gg/Kb9tkhecZT) community.