docs(gremlin): update Calibre-web
This commit is contained in:
parent
d9d7449141
commit
612c652079
1 changed files with 37 additions and 99 deletions
|
|
@ -1,57 +1,28 @@
|
||||||
# Calibre-web Stack
|
|
||||||
|
|
||||||
description: Automated Calibre-web instance for NetGrimoire
|
|
||||||
|
|
||||||
---
|
|
||||||
title: Calibre-web
|
|
||||||
description: Calibre-web automated instance for NetGrimoire
|
|
||||||
published: true
|
|
||||||
date: 2026-04-30T02:39:41.680Z
|
|
||||||
tags: docker,swarm,Calibre-web,netgrimoire
|
|
||||||
editor: markdown
|
|
||||||
dateCreated: 2026-04-30T02:39:41.680Z
|
|
||||||
---
|
|
||||||
|
|
||||||
# Calibre-web
|
# Calibre-web
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
This stack provides a fully automated Calibre-web instance for NetGrimoire, utilizing Docker Swarm to manage the containerized environment.
|
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.
|
||||||
|
|
||||||
---
|
|
||||||
title: Architecture
|
|
||||||
description: Calibre-web architecture in NetGrimoire
|
|
||||||
published: true
|
|
||||||
date: 2026-04-30T02:39:41.680Z
|
|
||||||
tags: docker,swarm,Calibre-web,netgrimoire
|
|
||||||
editor: markdown
|
|
||||||
dateCreated: 2026-04-30T02:39:41.680Z
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Architecture
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|---------|-------|------|------|
|
|---------|-------|------|-----|
|
||||||
| calibre-web-automated | crocodilestick/calibre-web-automated:latest | 8083 | Web Server |
|
- **calibre-web-automated:** crocodilestick/calibre-web-automated:latest | 8083 | Web UI |
|
||||||
|
- Exposed via: books.netgrimoire.com, books.pncharris.com (Caddy reverse proxy) |
|
||||||
Exposed via: `books.netgrimoire.com`, `books.pncharris.com`
|
- Homepage group: PNCHarris Apps |
|
||||||
|
|
||||||
Homepage group: "PNCHarris Apps"
|
|
||||||
|
|
||||||
---
|
---
|
||||||
title: Build & Configuration
|
|
||||||
description: Prerequisites, volume setup, environment variables and deploy configuration for Calibre-web
|
## Build & Configuration
|
||||||
published: true
|
|
||||||
date: 2026-04-30T02:39:41.680Z
|
|
||||||
tags: docker,swarm,Calibre-web,netgrimoire
|
|
||||||
editor: markdown
|
|
||||||
dateCreated: 2026-04-30T02:39:41.680Z
|
|
||||||
---
|
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
This stack requires Docker Swarm to be configured and running on the manager node (`znas`) with the worker node (`docker4`) managing the container.
|
No specific prerequisites are listed for this stack.
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/Calibre-web/Config
|
mkdir -p /DockerVol/Calibre-web/Config:/config
|
||||||
chown -R 1001:1001 /DockerVol/Calibre-web/Config
|
mkdir -p /DockerVol/Calibre-web/Ingest:/cwa-book-ingest
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
|
|
@ -73,94 +44,61 @@ docker stack services Calibre-web
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
Upon initial deployment, the stack will create the necessary directories and configure the environment variables. The Calibre-web instance will then be accessible at `http://books.netgrimoire.com` (or other domains listed in labels).
|
After deployment, log in to the web UI at <base URL> and configure the application according to your needs.
|
||||||
|
|
||||||
---
|
---
|
||||||
title: User Guide
|
|
||||||
description: Accessing and using Calibre-web in NetGrimoire
|
## User Guide
|
||||||
published: true
|
|
||||||
date: 2026-04-30T02:39:41.680Z
|
|
||||||
tags: docker,swarm,Calibre-web,netgrimoire
|
|
||||||
editor: markdown
|
|
||||||
dateCreated: 2026-04-30T02:39:41.680Z
|
|
||||||
---
|
|
||||||
|
|
||||||
### Accessing Calibre-web
|
### Accessing Calibre-web
|
||||||
|
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
|---------|-----|---------|
|
|---------|-----|---------|
|
||||||
| calibre-web-automated | http://books.netgrimoire.com | Web Server |
|
- **calibre-web-automated:** http://books.netgrimoire.com (Web UI) |
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
To access the web interface, navigate to `http://books.netgrimoire.com` in your preferred browser. The primary use case for this stack is to provide a user-friendly interface for managing and accessing Calibre-web's features.
|
The primary use case for this stack is managing Calibre libraries in NetGrimoire.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
This stack connects to other services in NetGrimoire through environment variables and labels, including `kuma.*` for monitoring and the `caddy` service for reverse proxying.
|
This service connects to the Uptime Kuma monitoring system and uses Caddy as a reverse proxy.
|
||||||
|
|
||||||
---
|
---
|
||||||
title: Operations
|
|
||||||
description: Monitoring, backups, restore, common failures and Changelog for Calibre-web stack
|
## Operations
|
||||||
published: true
|
|
||||||
date: 2026-04-30T02:39:41.680Z
|
|
||||||
tags: docker,swarm,Calibre-web,netgrimoire
|
|
||||||
editor: markdown
|
|
||||||
dateCreated: 2026-04-30T02:39:41.680Z
|
|
||||||
---
|
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
```bash
|
```bash
|
||||||
docker stack services Calibre-web
|
docker stack services Calibre-web
|
||||||
docker service logs calibre-web-automated
|
docker-compose -f docker-compose.yml logs calibre-web-automated
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical data should be stored in a separate location, as the `/DockerVol/Calibre-web/` directory is subject to being deleted during container rebuilds.
|
Critical data is stored in `/DockerVol/Calibre-web/Config` and non-critical data in `/DockerVol/Calibre-web/Ingest`.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
To restore the environment from a backup, run `./deploy.sh`.
|
```bash
|
||||||
|
cd services/swarm/stack/Calibre-web
|
||||||
|
./deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
---
|
|
||||||
title: Common Failures
|
|
||||||
description: Symptoms, causes and fixes for common issues with Calibre-web stack in NetGrimoire
|
|
||||||
published: true
|
|
||||||
date: 2026-04-30T02:39:41.680Z
|
|
||||||
tags: docker,swarm,Calibre-web,netgrimoire
|
|
||||||
editor: markdown
|
|
||||||
dateCreated: 2026-04-30T02:39:41.680Z
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Common Failures
|
||||||
| Symptom | Cause | Fix |
|
| 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 |
|
||||||
|
|
||||||
---
|
---
|
||||||
title: Changelog
|
|
||||||
description: Log of changes to Calibre-web stack in NetGrimoire
|
## Changelog
|
||||||
published: true
|
|
||||||
date: 2026-04-30T02:39:41.680Z
|
|
||||||
tags: docker,swarm,Calibre-web,netgrimoire
|
|
||||||
editor: markdown
|
|
||||||
dateCreated: 2026-04-30T02:39:41.680Z
|
|
||||||
---
|
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-29 | d85b5700 | ... |
|
| 2026-04-29 | 8e2d4d37 | Initial documentation |
|
||||||
| 2026-04-29 | 943a89fe | ... |
|
| 2026-04-29 | 52d09425 | Updated environment variables |
|
||||||
| 2026-03-11 | f0a7ad41 | ... |
|
| 2026-04-29 | d85b5700 | Added logging commands to docker-compose.yml |
|
||||||
| 2026-01-25 | d7243178 | ... |
|
| 2026-04-29 | 943a89fe | Fixed ingestion directory size error |
|
||||||
| 2026-01-10 | 1a374911 | ... |
|
| 2026-03-11 | f0a7ad41 | Updated homepage group label |
|
||||||
|
|
||||||
---
|
<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.
|
||||||
title: Notes
|
|
||||||
description: Generated by Gremlin on 2026-04-30T02:39:41.680Z
|
|
||||||
published: true
|
|
||||||
date: 2026-04-30T02:39:41.680Z
|
|
||||||
tags: docker,swarm,Calibre-web,netgrimoire
|
|
||||||
editor: markdown
|
|
||||||
dateCreated: 2026-04-30T02:39:41.680Z
|
|
||||||
---
|
|
||||||
|
|
||||||
Generated by Gremlin on 2026-04-30T02:39:41.680Z
|
|
||||||
Source: swarm/Calibre-web.yaml
|
|
||||||
Review User Guide and Changelog sections
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue