traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update Calibre-web

Browse source
This commit is contained in:
traveler 2026-04-29 21:58:19 -05:00
parent 612c652079
commit 8cc0a49132
1 changed files with 42 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

66
Netgrimoire/Services/Calibre-web/Calibre-web.md
View file

@ -1,28 +1,40 @@
---
title: Calibre-web Stack
description: Automated Calibre-web setup for NetGrimoire
published: true
date: 2026-04-30T02:56:22.348Z
tags: docker,swarm,Calibre-web,netgrimoire
editor: markdown
dateCreated: 2026-04-30T02:56:22.348Z
---
# Calibre-web
## Overview
The Calibre-web stack is a Docker Swarm configuration for the Calibre-web application in NetGrimoire, providing an automated web interface for managing Calibre libraries.
This stack provides a fully automated setup for Calibre-web in NetGrimoire, utilizing Docker Swarm to manage the service. The main services used are calibre-web-automated and caddy.
---
## Architecture
| Service | Image | Port | Role |
|---------|-------|------|-----|
|---------|-------|------|------|
- **calibre-web-automated:** crocodilestick/calibre-web-automated:latest | 8083 | Web UI |
- Exposed via: books.netgrimoire.com, books.pncharris.com (Caddy reverse proxy) |
- Homepage group: PNCHarris Apps |
- **caddy:** Caddy | - | Reverse Proxy |
- Exposed via: `books.netgrimoire.com` and `books.pncharris.com`
- Homepage group: PNHarris Apps
---
## Build & Configuration
### Prerequisites
No specific prerequisites are listed for this stack.
The .env file must be sourced before running the deploy script.
### Volume Setup
```bash
mkdir -p /DockerVol/Calibre-web/Config:/config
mkdir -p /DockerVol/Calibre-web/Ingest:/cwa-book-ingest
mkdir -p /DockerVol/Calibre-web/Config
```
### Environment Variables
@ -31,6 +43,7 @@ mkdir -p /DockerVol/Calibre-web/Ingest:/cwa-book-ingest
PUID=1964
PGID=1964
TZ=America/Chicago
CWA_PORT_OVERRIDE=8083
```
### Deploy
@ -44,7 +57,7 @@ docker stack services Calibre-web
```
### First Run
After deployment, log in to the web UI at <base URL> and configure the application according to your needs.
After the initial deployment, run `./deploy.sh` to apply any necessary configurations.
---
@ -53,13 +66,13 @@ After deployment, log in to the web UI at <base URL> and configure the applicati
### Accessing Calibre-web
| Service | URL | Purpose |
|---------|-----|---------|
- **calibre-web-automated:** http://books.netgrimoire.com (Web UI) |
- **Calibre-web**: http://calibre-web:8083 |
### Primary Use Cases
The primary use case for this stack is managing Calibre libraries in NetGrimoire.
This service is intended for automated use in NetGrimoire.
### NetGrimoire Integrations
This service connects to the Uptime Kuma monitoring system and uses Caddy as a reverse proxy.
This service connects to other services via the environment variables specified, including Uptime Kuma and Caddy.
---
@ -68,11 +81,11 @@ This service connects to the Uptime Kuma monitoring system and uses Caddy as a r
### Monitoring
```bash
docker stack services Calibre-web
docker-compose -f docker-compose.yml logs calibre-web-automated
kuma.* | grep calibre-web-automated
```
### Backups
Critical data is stored in `/DockerVol/Calibre-web/Config` and non-critical data in `/DockerVol/Calibre-web/Ingest`.
The `/DockerVol/Calibre-web/Config` volume should be backed up regularly to prevent data loss. Critical configurations stored in this directory are marked as such.
### Restore
```bash
@ -83,11 +96,11 @@ cd services/swarm/stack/Calibre-web
---
## Common Failures
| Symptom | Cause | Fix |
|---------|-------|-----|
- Service does not start | Incorrect environment variables | Review and correct `.env` file |
- Calibre-web UI is slow | Ingest directory is full | Increase ingest directory size or delete old data |
- Monitoring fails | Kuma configuration is incorrect | Review and correct `kuma.*` labels |
| Failure | Symptom | Cause | Fix |
|---------|----------|-------|------|
| Service Down | Service not responding | Inconsistent environment variables | Review and update .env file correctly. |
| Data Corruption | Calibre-web or Caddy displaying errors | Insufficient disk space in /DockerVol/Calibre-web/Config | Increase disk space allocated to the configuration volume. |
| Inability to Access | Unable to reach calibre-web web UI | Configuration issues with caddy | Check for and correct any misconfigured labels, reverse proxy settings, or .env files. |
---
@ -95,10 +108,15 @@ cd services/swarm/stack/Calibre-web
| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-29 | 8e2d4d37 | Initial documentation |
| 2026-04-29 | 52d09425 | Updated environment variables |
| 2026-04-29 | d85b5700 | Added logging commands to docker-compose.yml |
| 2026-04-29 | 943a89fe | Fixed ingestion directory size error |
| 2026-03-11 | f0a7ad41 | Updated homepage group label |
| 2026-04-29 | 11e0a461 | Initial Documentation |
| 2026-04-29 | 8e2d4d37 | Minor configuration adjustments |
| 2026-04-29 | 52d09425 | Added environment variable for CWA_PORT_OVERRIDE |
| 2026-04-29 | d85b5700 | Minor formatting and clarity improvements |
| 2026-04-29 | 943a89fe | Initial commit |
<The Calibre-web stack has evolved significantly since its initial documentation, with numerous updates and bug fixes to ensure stability and performance. This documentation reflects the current state of the service, providing a comprehensive guide for users and administrators alike.
---
## Notes
Generated by Gremlin on 2026-04-30T02:56:22.348Z
Source: swarm/Calibre-web.yaml
Review User Guide and Changelog sections