diff --git a/Netgrimoire/Services/Calibre-web/Calibre-web.md b/Netgrimoire/Services/Calibre-web/Calibre-web.md new file mode 100644 index 0000000..5d72b2b --- /dev/null +++ b/Netgrimoire/Services/Calibre-web/Calibre-web.md @@ -0,0 +1,123 @@ +--- +title: Calibre-web Stack +description: Automated Calibre-web instance for NetGrimoire +published: true +date: 2026-04-30T02:39:40.142Z +tags: docker,swarm,Calibre-web,netgrimoire +editor: markdown +dateCreated: 2026-04-30T02:39:40.142Z +--- + +# Calibre-web + +## 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. + +--- + +## Architecture + +| Service | Image | Port | Role | +|-|-|-|-| +- **calibre-web-automated**: crocodilestick/calibre-web-automated:latest | 8083 | Web UI and API | + - Host: docker4 + - Network: netgrimoire + - Exposed via: books.netgrimoire.com, books.pncharris.com + - Homepage group: PNCHarris Apps + +--- + +## Build & Configuration + +### Prerequisites +This stack requires Docker Swarm and a compatible environment to run. + +### Volume Setup +```bash +mkdir -p /DockerVol/Calibre-web/Config +chown -R calibre-user:calibre-group /DockerVol/Calibre-web/Config +``` + +### Environment Variables +```bash +# generate: openssl rand -hex 32 +PUID=1964 +PGID=1964 +TZ=America/Chicago +CWA_PORT_OVERRIDE=8083 +``` + +### Deploy +```bash +cd services/swarm/stack/Calibre-web +set -a && source .env && set +a +docker stack config --compose-file Calibre-web-stack.yml > resolved.yml +docker stack deploy --compose-file resolved.yml Calibre-web +rm resolved.yml +docker stack services Calibre-web +``` + +### First Run +After deploying the stack, ensure that all services are running and the CWA configuration is set up correctly. + +--- + +## User Guide + +### Accessing Calibre-web +| Service | URL | +|---------|-----| +- **calibre-web-automated**: http://calibre-web-automated:8083 | + +### 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. + +### 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. + +--- + +## Operations + +### Monitoring +Use Kuma monitoring to track the performance of this stack. +```bash +docker stack services Calibre-web +docker service logs calibre-web-automated -f +``` + +### Backups +Critical data is stored on a persistent volume at `/DockerVol/Calibre-web/library`. Regular backups are recommended to ensure data integrity. + +### Restore +To restore the stack, re-run the deploy script. +```bash +cd services/swarm/stack/Calibre-web +./deploy.sh +``` + +--- + +## Common Failures + +| Symptom | Cause | Fix | +|-|-|-| +- Calibre-web instance not starting | Insufficient resources or configuration issues | Check resource requirements and adjust configuration as needed. | + +--- + +## Changelog + +| Date | Commit | Summary | +|------|--------|---------| +| 2026-04-29 | 943a89fe | Initial documentation and setup | +| 2026-03-11 | f0a7ad41 | Minor configuration tweaks and bug fixes | +| 2026-01-25 | d7243178 | Updated dependencies and improved security | +| 2026-01-10 | 1a374911 | Improved performance and stability | + +--- + +## Notes +- Generated by Gremlin on 2026-04-30T02:39:40.142Z +- Source: swarm/Calibre-web.yaml +- Review User Guide and Changelog sections \ No newline at end of file