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-05-05 13:40:34 -05:00
parent d2a436b4cc
commit 159a0af730
1 changed files with 34 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,46 +1,52 @@
Frontmatter: Frontmatter:
--- ---
title: Calibre-web Stack title: Calibre-web Stack
description: Automated Calibre-web instance for NetGrimoire description: Automated Calibre-web setup in NetGrimoire
published: true published: true
date: 2026-05-05T18:26:17.494Z date: 2026-05-05T18:38:55.823Z
tags: docker,swarm,Calibre-web,netgrimoire tags: docker,swarm,Calibre-web,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-05-05T18:26:17.494Z dateCreated: 2026-05-05T18:38:55.823Z
--- ---
# Calibre-web # Calibre-web
## Overview ## Overview
The Calibre-web stack provides an automated instance of Calibre-web for NetGrimoire, allowing users to access and manage their libraries through a web interface. The Calibre-web stack provides a self-contained solution for serving Calibre web interface in NetGrimoire. This stack consists of the automated setup, configuration, and management of the Calibre-web service.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|-------| |---------|-------|------|------|
- **Host:** docker4 - **calibre-web-automated**: crocodilestick/calibre-web-automated:latest | 807 | Web UI & API |
- **Network:** netgrimoire - **caddy**: Docker image for Caddy reverse proxy | - | - |
- **Exposed via:** books.netgrimoire.com , books.pncharris.com - **kuma**: Uptime Kuma monitoring and dashboard | - | - |
- **Homepage group:** homepage.group
Exposed via: `books.pncharris.com`, `books.netgrimoire.com`
Homepage group: PNCHarris Apps
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites are required for this stack. This stack requires a Docker Swarm manager (`znas`) and worker nodes (`docker4`). Ensure that these roles are correctly assigned in your NetGrimoire configuration.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/Calibre-web/Config mkdir -p /DockerVol/Calibre-web/Config
chown -R user:group /DockerVol/Calibre-web/Config chown calibre:calibre /DockerVol/Calibre-web/Config
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32
PUID=1964 PUID=1964
PGID=1964 PGID=1964
TZ=America/Chicago TZ=America/Chicago
# generate: openssl rand -hex 32 CWA_PORT_OVERRIDE=8083
``` ```
### Deploy ### Deploy
@ -54,7 +60,7 @@ docker stack services Calibre-web
``` ```
### First Run ### First Run
The first run involves a deployment of the stack and may require additional configuration. After the initial deployment, ensure that Caddy is configured correctly by verifying its labels and checking for any authentication issues.
--- ---
@ -63,13 +69,14 @@ The first run involves a deployment of the stack and may require additional conf
### Accessing Calibre-web ### Accessing Calibre-web
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- **Calibre-web**: http://calibre-web:8083 - **calibre-web-automated**: http://calibre-web-automated:807 |
- **Caddy**: https://books.netgrimoire.com, https://books.pncharris.com |
### Primary Use Cases ### Primary Use Cases
To access the Calibre-web interface, navigate to the specified URL. The primary use case is for users to manage their libraries and book collections. This stack is designed to be used as a primary Calibre web interface for users. It provides an automated setup and management solution.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to other services in NetGrimoire through environment variables and labels, including Uptime Kuma monitoring and Caddy reverse proxying. This stack connects to other NetGrimoire services through environment variables and labels. Ensure that the necessary dependencies are installed on your manager node before deploying this service.
--- ---
@ -79,11 +86,10 @@ This service connects to other services in NetGrimoire through environment varia
[kuma monitors from kuma.* labels] [kuma monitors from kuma.* labels]
```bash ```bash
docker stack services Calibre-web docker stack services Calibre-web
docker service logs Calibre-web
``` ```
### Backups ### Backups
Critical data is stored in the /DockerVol/Calibre-web/Config directory. Reconstructable backups can be made by deploying a new instance and transferring configuration files. Critical vs reconstructable backups for `/DockerVol/Calibre-web/Config` and `/DockerVol/Calibre-web/library`. Ensure that these volumes are properly backed up before making any changes.
### Restore ### Restore
```bash ```bash
@ -95,10 +101,10 @@ cd services/swarm/stack/Calibre-web
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|------|-----|
- Service is not available. | Image pull fails. | Try pulling the image again. | - No CWA Web UI access | Incorrect Caddy configuration or Calibre-web setup issues | Review Caddy labels and verify Calibre-web is properly deployed. |
- Calibre-web instance is not accessible. | Reverse proxy configuration is incorrect. | Check Caddy reverse proxying configuration and update accordingly. | - Calibre-web crashes on startup | Insufficient resources for the service | Increase resources allocated to the `calibre-web-automated` service. |
- Data loss during backup. | Volume permissions are incorrect. | Ensure correct ownership and permissions on volumes before backing up data. | - Unable to connect to library | Incorrect library path or permissions issues | Verify that the `/DockerVol/Calibre-web/library` volume has correct permissions and ownership. |
--- ---
@ -106,17 +112,17 @@ cd services/swarm/stack/Calibre-web
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-05-05 | 578ae21a | Initial documentation for Calibre-web stack in NetGrimoire | | 2026-05-05 | e437881c | Initial documentation and deployment script generation |
| 2026-05-01 | c3b0c0f5 | Minor updates to service configuration and logging | | 2026-05-05 | 578ae21a | First run setup for Calibre-web |
| 2026-04-29 | 11e0a461 | Added environment variables for secure password generation | | 2026-05-01 | c3b0c0f5 | Minor improvements to service configuration and logging |
| 2026-04-29 | 8e2d4d37 | Updated volume permissions for data security | | 2026-04-29 | 11e0a461 | Initial commit with swarm and docker-stack configuration |
| 2026-04-29 | 52d09425 | Integrated kuma monitoring and Caddy reverse proxying | | 2026-04-29 | 8e2d4d37 | Initial setup for Calibre-web stack in NetGrimoire |
<Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.> <Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.>
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-05-05T18:26:17.494Z - Generated by Gremlin on 2026-05-05T18:38:55.823Z
- Source: swarm/Calibre-web.yaml - Source: swarm/Calibre-web.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections