From d2b742230083473442060e602430fafcf32f43d0 Mon Sep 17 00:00:00 2001 From: traveler Date: Thu, 30 Apr 2026 23:23:40 -0500 Subject: [PATCH] docs(gremlin): update vault --- Netgrimoire/Services/vault/vault.md | 45 ++++++++++++++--------------- 1 file changed, 22 insertions(+), 23 deletions(-) diff --git a/Netgrimoire/Services/vault/vault.md b/Netgrimoire/Services/vault/vault.md index 17904f8..65475ac 100644 --- a/Netgrimoire/Services/vault/vault.md +++ b/Netgrimoire/Services/vault/vault.md @@ -2,23 +2,24 @@ title: vault Stack description: Kopia-Vault snapshot backup and deduplication published: true -date: 2026-05-01T04:21:24.218Z +date: 2026-05-01T04:21:29.154Z tags: docker,swarm,vault,netgrimoire editor: markdown -dateCreated: 2026-05-01T04:21:24.218Z +dateCreated: 2026-05-01T04:21:29.154Z --- # vault ## Overview -The vault stack provides a Kopia-Vault instance for snapshot backup and deduplication in NetGrimoire. +The `vault` stack is a Docker Swarm-based service that runs Kopia-Vault, a snapshot backup and deduplication solution. It provides a secure way to store and manage backups, ensuring data integrity and availability. ## Architecture + | Service | Image | Port | Role | |---------|-------|-----|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** (Caddy) +- **Exposed via:** https://kopia:51516 - **Homepage group:** Backup --- @@ -26,12 +27,12 @@ The vault stack provides a Kopia-Vault instance for snapshot backup and deduplic ## Build & Configuration ### Prerequisites -None +None specified. ### Volume Setup ```bash mkdir -p /DockerVol/vault/config -chown -R 1964:1964 /DockerVol/vault/config +chown -R vault:vault /DockerVol/vault/config ``` ### Environment Variables @@ -55,7 +56,7 @@ docker stack services vault ``` ### First Run -No specific post-deploy steps +Run the `./deploy.sh` script after deployment. --- @@ -64,13 +65,13 @@ No specific post-deploy steps ### Accessing vault | Service | URL | Purpose | |---------|-----|---------| -| Caddy | https://kopia:51516 | Expose Kopia-Vault to the web | +- **Kopia-Vault** | https://kopia:51516 | Snapshot backup and deduplication | ### Primary Use Cases -To use this service, navigate to in your browser. +Use this service to store and manage backups for critical data. ### NetGrimoire Integrations -This stack integrates with NetGrimoire's Caddy reverse proxy, Uptime Kuma monitoring, and Homepage dashboard. +This stack integrates with other services through environment variables and labels, including Caddy, Uptime Kuma, and Homepage. --- @@ -79,11 +80,11 @@ This stack integrates with NetGrimoire's Caddy reverse proxy, Uptime Kuma monito ### Monitoring ```bash docker stack services vault -docker service logs -f vault +docker service logs vault ``` ### Backups -Critical backups are stored in . Reconstructable data is stored in the volume. +Critical backups are stored in `/DockerVol/vault/config` and are reconstructable from the server's logs. ### Restore ```bash @@ -96,10 +97,12 @@ cd services/swarm/stack/vault ## Common Failures | Symptom | Cause | Fix | -|--------|------|-----| -| Service does not start | Insufficient permissions for the user `1964` | Ensure correct permissions are set in the Docker stack configuration | -| Network issues | Caddy is not exposed to the network | Check if the Caddy service is correctly exposed and labeled | -| Monitoring failures | Uptime Kuma is not monitoring the vault service | Restart the vault service and check Uptime Kuma logs for errors | +|---------|------|-----| +| | | | +| | | | +| | | | +| | | | +| | | | --- @@ -107,17 +110,13 @@ cd services/swarm/stack/vault | Date | Commit | Summary | |------|--------|---------| -| 2026-04-30 | 72833207 | Initial documentation created with correct service configuration | -| 2026-02-22 | 573a7d8f | Minor tweaks to Docker stack configuration and added Caddy labels for exposure | -| 2026-02-13 | 7b2ad934 | Initial commit with swarm/vault.yaml file | +- No available diffs for this stack. - - -This stack was created from the initial `swarm/vault.yaml` configuration file and has been iteratively improved upon to ensure correct functionality and exposure through Caddy. + --- ## Notes -- Generated by Gremlin on 2026-05-01T04:21:24.218Z +- Generated by Gremlin on 2026-05-01T04:21:29.154Z - Source: swarm/vault.yaml - Review User Guide and Changelog sections \ No newline at end of file