docs(gremlin): update Calibre-web
This commit is contained in:
parent
eeaaff28af
commit
d9d7449141
1 changed files with 93 additions and 50 deletions
|
|
@ -1,41 +1,57 @@
|
||||||
---
|
# Calibre-web Stack
|
||||||
title: Calibre-web Stack
|
|
||||||
description: Automated Calibre-web instance for NetGrimoire
|
description: Automated Calibre-web instance for NetGrimoire
|
||||||
|
|
||||||
|
---
|
||||||
|
title: Calibre-web
|
||||||
|
description: Calibre-web automated instance for NetGrimoire
|
||||||
published: true
|
published: true
|
||||||
date: 2026-04-30T02:39:40.142Z
|
date: 2026-04-30T02:39:41.680Z
|
||||||
tags: docker,swarm,Calibre-web,netgrimoire
|
tags: docker,swarm,Calibre-web,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-04-30T02:39:40.142Z
|
dateCreated: 2026-04-30T02:39:41.680Z
|
||||||
---
|
---
|
||||||
|
|
||||||
# Calibre-web
|
# Calibre-web
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
This stack automates the deployment and configuration of a Calibre-web instance in NetGrimoire, providing access to a web-based interface for managing your library.
|
This stack provides a fully automated Calibre-web instance for NetGrimoire, utilizing Docker Swarm to manage the containerized environment.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
title: Architecture
|
||||||
## 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
|
||||||
|
---
|
||||||
|
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|-|-|-|-|
|
|---------|-------|------|------|
|
||||||
- **calibre-web-automated**: crocodilestick/calibre-web-automated:latest | 8083 | Web UI and API |
|
| calibre-web-automated | crocodilestick/calibre-web-automated:latest | 8083 | Web Server |
|
||||||
- Host: docker4
|
|
||||||
- Network: netgrimoire
|
Exposed via: `books.netgrimoire.com`, `books.pncharris.com`
|
||||||
- Exposed via: books.netgrimoire.com, books.pncharris.com
|
|
||||||
- Homepage group: PNCHarris Apps
|
Homepage group: "PNCHarris Apps"
|
||||||
|
|
||||||
---
|
---
|
||||||
|
title: Build & Configuration
|
||||||
## Build & Configuration
|
description: Prerequisites, volume setup, environment variables and deploy configuration for Calibre-web
|
||||||
|
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 and a compatible environment to run.
|
This stack requires Docker Swarm to be configured and running on the manager node (`znas`) with the worker node (`docker4`) managing the container.
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/Calibre-web/Config
|
mkdir -p /DockerVol/Calibre-web/Config
|
||||||
chown -R calibre-user:calibre-group /DockerVol/Calibre-web/Config
|
chown -R 1001:1001 /DockerVol/Calibre-web/Config
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
|
|
@ -44,7 +60,6 @@ chown -R calibre-user:calibre-group /DockerVol/Calibre-web/Config
|
||||||
PUID=1964
|
PUID=1964
|
||||||
PGID=1964
|
PGID=1964
|
||||||
TZ=America/Chicago
|
TZ=America/Chicago
|
||||||
CWA_PORT_OVERRIDE=8083
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Deploy
|
### Deploy
|
||||||
|
|
@ -58,66 +73,94 @@ docker stack services Calibre-web
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
After deploying the stack, ensure that all services are running and the CWA configuration is set up correctly.
|
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).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
title: User Guide
|
||||||
## User Guide
|
description: Accessing and using Calibre-web 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
|
||||||
|
---
|
||||||
|
|
||||||
### Accessing Calibre-web
|
### Accessing Calibre-web
|
||||||
| Service | URL |
|
|
||||||
|---------|-----|
|
| Service | URL | Purpose |
|
||||||
- **calibre-web-automated**: http://calibre-web-automated:8083 |
|
|---------|-----|---------|
|
||||||
|
| calibre-web-automated | http://books.netgrimoire.com | Web Server |
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
To use Calibre-web in NetGrimoire, navigate to the Calibre-web instance and follow the on-screen instructions to configure your library.
|
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.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
This stack integrates with other services in NetGrimoire via environment variables and labels. For more information, refer to the corresponding documentation for each service.
|
This stack connects to other services in NetGrimoire through environment variables and labels, including `kuma.*` for monitoring and the `caddy` service for reverse proxying.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
title: Operations
|
||||||
## Operations
|
description: Monitoring, backups, restore, common failures and Changelog for Calibre-web stack
|
||||||
|
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
|
||||||
Use Kuma monitoring to track the performance of this stack.
|
|
||||||
```bash
|
```bash
|
||||||
docker stack services Calibre-web
|
docker stack services Calibre-web
|
||||||
docker service logs calibre-web-automated -f
|
docker service logs calibre-web-automated
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical data is stored on a persistent volume at `/DockerVol/Calibre-web/library`. Regular backups are recommended to ensure data integrity.
|
Critical data should be stored in a separate location, as the `/DockerVol/Calibre-web/` directory is subject to being deleted during container rebuilds.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
To restore the stack, re-run the deploy script.
|
To restore the environment from a backup, run `./deploy.sh`.
|
||||||
```bash
|
|
||||||
cd services/swarm/stack/Calibre-web
|
|
||||||
./deploy.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
title: Common Failures
|
||||||
## 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
|
||||||
|
---
|
||||||
|
|
||||||
| Symptom | Cause | Fix |
|
| Symptom | Cause | Fix |
|
||||||
|-|-|-|
|
|---------|-------|-----|
|
||||||
- Calibre-web instance not starting | Insufficient resources or configuration issues | Check resource requirements and adjust configuration as needed. |
|
| ... | ... | ... |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
title: Changelog
|
||||||
## Changelog
|
description: Log of changes to 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
|
||||||
|
---
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-29 | 943a89fe | Initial documentation and setup |
|
| 2026-04-29 | d85b5700 | ... |
|
||||||
| 2026-03-11 | f0a7ad41 | Minor configuration tweaks and bug fixes |
|
| 2026-04-29 | 943a89fe | ... |
|
||||||
| 2026-01-25 | d7243178 | Updated dependencies and improved security |
|
| 2026-03-11 | f0a7ad41 | ... |
|
||||||
| 2026-01-10 | 1a374911 | Improved performance and stability |
|
| 2026-01-25 | d7243178 | ... |
|
||||||
|
| 2026-01-10 | 1a374911 | ... |
|
||||||
|
|
||||||
|
---
|
||||||
|
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
|
||||||
---
|
---
|
||||||
|
|
||||||
## Notes
|
Generated by Gremlin on 2026-04-30T02:39:41.680Z
|
||||||
- Generated by Gremlin on 2026-04-30T02:39:40.142Z
|
Source: swarm/Calibre-web.yaml
|
||||||
- Source: swarm/Calibre-web.yaml
|
Review User Guide and Changelog sections
|
||||||
- Review User Guide and Changelog sections
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue