From fccc7902ed5d7d987c55866c8abe617690396c0c Mon Sep 17 00:00:00 2001 From: traveler Date: Thu, 30 Apr 2026 18:47:15 -0500 Subject: [PATCH] docs(gremlin): update kopia --- Netgrimoire/Services/kopia/kopia.md | 81 ++++++++--------------------- 1 file changed, 21 insertions(+), 60 deletions(-) diff --git a/Netgrimoire/Services/kopia/kopia.md b/Netgrimoire/Services/kopia/kopia.md index 60a2f3f..f8c9261 100644 --- a/Netgrimoire/Services/kopia/kopia.md +++ b/Netgrimoire/Services/kopia/kopia.md @@ -1,28 +1,25 @@ --- title: kopia Stack -description: Kopia snapshot backup and deduplication service in NetGrimoire. +description: Snapshot backup and deduplication service in NetGrimoire. published: true -date: 2026-04-30T22:51:02.688Z +date: 2026-04-30T23:46:07.706Z tags: docker,swarm,kopia,netgrimoire editor: markdown -dateCreated: 2026-04-30T22:51:02.688Z +dateCreated: 2026-04-30T23:46:07.706Z --- # kopia ## Overview -The kopia Stack provides a snapshot backup and deduplication service in NetGrimoire. It consists of the kopia container running on node znas. - ---- +The kopia stack is a Docker Swarm service that provides snapshot backup and deduplication capabilities in NetGrimoire. It includes the kopia container, which runs as the root user with a password set by the environment variable KOPIA_PASSWORD. ## Architecture | Service | Image | Port | Role | -|---------|-------|------|------| -- **kopia:** `kopia/kopia:latest` | 51515 | Backup and Deduplication | - -Exposed via: `kopia.netgrimoire.com`, Internal only - -Homepage group: Backup +|---------|-----|-----|------| +- **Host:** docker4 +- **Network:** netgrimoire +- **Exposed via:** kopia.netgrimoire.com, Internal only +- **Homepage group:** Backup --- @@ -34,18 +31,14 @@ No specific prerequisites are required for this stack. ### Volume Setup ```bash mkdir -p /DockerVol/kopia/config -chown -R kopia:kopia /DockerVol/kopia/config +chown -R 1964:1964 /DockerVol/kopia/config ``` ### Environment Variables ```bash -# generate: openssl rand -hex 32 -KOPIA_PASSWORD=F@lcon13 -KOPIA_SERVER_USERNAME=admin -KOPIA_SERVER_PASSWORD=F@lcon13 +KOPIA_PASSWORD=$(openssl rand -hex 32) PUID=1964 PGID=1964 -TZ=America/Chicago ``` ### Deploy @@ -59,25 +52,23 @@ docker stack services kopia ``` ### First Run -Run the following command to complete the initial setup: -```bash -./deploy.sh -``` +After deployment, access the kopia web interface at https://kopia.netgrimoire.com and login with username admin and password F@lcon13. --- ## User Guide ### Accessing kopia -| Service | URL | -|---------|-----| -- **kopia:** https://kopia.netgrimoire.com | +| Service | URL | Purpose | +|---------|-----|---------| +- **Host:** kopia.netgrimoire.com, Internal only +- **Purpose:** Access the kopia web interface. ### Primary Use Cases -To use kopia, navigate to its homepage and follow the instructions. +To use kopia in NetGrimoire, deploy this stack and access its web interface at https://kopia.netgrimoire.com. Configure your backup destinations using the UI. ### NetGrimoire Integrations -Kopia connects to other services through environment variables and labels. +This service connects to Vault for backup storage and Kuma for monitoring. --- @@ -87,41 +78,11 @@ Kopia connects to other services through environment variables and labels. [kuma monitors from kuma.* labels] ```bash docker stack services kopia -docker service logs kopia +docker service logs -f kopia ``` ### Backups -Critical backups are stored in `/DockerVol/kopia/config` and reconstructed from the `kopia.cache` directory. +The critical volume paths are /DockerVol/kopia/config, /DockerVol/kopia/cache, and /data/nfs/znas/Docker/kopia/logs. ### Restore -To restore data, run: -```bash -./deploy.sh -``` - ---- - -## Common Failures -| Symptom | Cause | Fix | -|---------|------|-----| -| Service not reachable | caddy reverse proxy issue | Check caddy logs and restart if necessary | -| Data corruption | kopia configuration error | Review configuration files and correct any errors | - ---- - -## Changelog - -| Date | Commit | Summary | -|------|--------|---------| -| 2026-04-30 | 63206bb4 | Initial documentation | -| 2026-04-30 | ef044b3a | Added environment variables | -| 2026-04-30 | 2a6755f4 | Improved volume setup | -| 2026-04-30 | 139f4ed4 | Enhanced deploy script | -| 2026-04-30 | 2c94a8d9 | Fixed kopia configuration | -| 2026-04-07 | d3206f11 | Added logging commands | -| 2026-02-11 | aa13ac64 | Improved restore instructions | -| 2026-01-30 | 15f5f655 | Initial documentation | - -Generated by Gremlin on 2026-04-30T22:51:02.688Z -Source: swarm/kopia.yaml -Review User Guide and Changelog sections \ No newline at end of file +To restore a backup, deploy this stack and use the `--restore` option with the kopia command-line interface. \ No newline at end of file