3.4 KiB
3.4 KiB
| title | description | published | date | tags | editor | dateCreated |
|---|---|---|---|---|---|---|
| kopia Stack | Self-contained backup and deduplication service | true | 2026-05-01T03:56:13.183Z | docker,swarm,kopia,netgrimoire | markdown | 2026-05-01T03:56:13.183Z |
kopia
Overview
The kopia stack provides a self-contained backup and deduplication service for NetGrimoire. It consists of the kopia service, which runs on docker4, and is exposed via caddy's reverse proxy.
Architecture
| Service | Image | Port | Role |
- Host: docker4
- Network: netgrimoire
- Exposed via: https://kopia.netgrimoire.com
- Homepage group: Backup
| Service | URL | Purpose |
|---|---|---|
| https://kopia.netgrimoire.com | / | Primary access point for kopia |
Build & Configuration
Prerequisites
- Docker and Docker Swarm installed on docker4
Volume Setup
mkdir -p /DockerVol/kopia/config
chown -R 1964:1964 /DockerVol/kopia/config
Environment Variables
PUID=1964
PGID=1964
TZ=America/Chicago
KOPIA_PASSWORD=F@lcon13
KOPIA_SERVER_USERNAME=admin
KOPIA_SERVER_PASSWORD=F@lcon13
Deploy
cd services/swarm/stack/kopia
set -a && source .env && set +a
docker stack config --compose-file kopia-stack.yml > resolved.yml
docker stack deploy --compose-file resolved.yml kopia
rm resolved.yml
docker stack services kopia
First Run
cd services/swarm/stack/kopia
./deploy.sh
User Guide
Accessing kopia
| Service | URL | Purpose |
|---|---|---|
| https://kopia.netgrimoire.com | / | Primary access point for kopia |
Primary Use Cases
- Backup and restore data using the kopia service.
NetGrimoire Integrations
- The kopia service integrates with other NetGrimoire services through environment variables and labels, including Uptime Kuma monitoring and Caddy reverse proxying.
Operations
Monitoring
kuma.*:
docker stack services kopia
<docker service logs commands>
Backups
Critical vs reconstructable /DockerVol/ paths are not explicitly documented. Please refer to the environment variables for configuration details.
Restore
cd services/swarm/stack/kopia
./deploy.sh
Common Failures
- Symptom: kopia service is unavailable.
- Cause: Incorrect environment variable settings or network issues.
- Fix: Verify environment variable settings and ensure the kopia service is up and running.
Changelog
| Date | Commit | Summary |
|---|---|---|
| 2026-04-30 | 11630569 | Initial documentation for kopia stack |
| 2026-04-30 | c96ddaf6 | Updated environment variable values to include PUID, PGID, and TZ settings |
| 2026-04-30 | 305a9f61 | Improved volume setup instructions |
| 2026-04-30 | 1fcb172d | Enhanced kopia service configuration for better security |
| 2026-04-30 | d8aa769c | Added logging and monitoring features to the kopia stack |
| 2026-04-30 | d7156fa2 | Fixed environment variable settings for correct kopia behavior |
| 2026-04-30 | 9bc4c652 | Updated deployment instructions for better security |
| 2026-04-30 | 9b143d26 | Improved documentation for Uptime Kuma monitoring and Caddy reverse proxying |
| 2026-04-30 | 63206bb4 | Enhanced logging and monitoring features for the kopia service |
| 2026-04-30 | ef044b3a | Finalized initial documentation for the kopia stack |
Notes
- Generated by Gremlin on 2026-05-01T03:56:13.183Z
- Source: swarm/kopia.yaml
- Review User Guide and Changelog sections