diff --git a/Netgrimoire/Services/vault/vault.md b/Netgrimoire/Services/vault/vault.md new file mode 100644 index 0000000..17904f8 --- /dev/null +++ b/Netgrimoire/Services/vault/vault.md @@ -0,0 +1,123 @@ +--- +title: vault Stack +description: Kopia-Vault snapshot backup and deduplication +published: true +date: 2026-05-01T04:21:24.218Z +tags: docker,swarm,vault,netgrimoire +editor: markdown +dateCreated: 2026-05-01T04:21:24.218Z +--- + +# vault + +## Overview +The vault stack provides a Kopia-Vault instance for snapshot backup and deduplication in NetGrimoire. + +## Architecture +| Service | Image | Port | Role | +|---------|-------|-----|------| +- **Host:** docker4 +- **Network:** netgrimoire +- **Exposed via:** (Caddy) +- **Homepage group:** Backup + +--- + +## Build & Configuration + +### Prerequisites +None + +### Volume Setup +```bash +mkdir -p /DockerVol/vault/config +chown -R 1964:1964 /DockerVol/vault/config +``` + +### Environment Variables +```bash +PUID=1964 +PGID=1964 +TZ=America/Chicago +KOPIA_PASSWORD=F@lcon13 +KOPIA_SERVER_USERNAME=admin +KOPIA_SERVER_PASSWORD=F@lcon13 +``` + +### Deploy +```bash +cd services/swarm/stack/vault +set -a && source .env && set +a +docker stack config --compose-file vault-stack.yml > resolved.yml +docker stack deploy --compose-file resolved.yml vault +rm resolved.yml +docker stack services vault +``` + +### First Run +No specific post-deploy steps + +--- + +## User Guide + +### Accessing vault +| Service | URL | Purpose | +|---------|-----|---------| +| Caddy | https://kopia:51516 | Expose Kopia-Vault to the web | + +### Primary Use Cases +To use this service, navigate to in your browser. + +### NetGrimoire Integrations +This stack integrates with NetGrimoire's Caddy reverse proxy, Uptime Kuma monitoring, and Homepage dashboard. + +--- + +## Operations + +### Monitoring +```bash +docker stack services vault +docker service logs -f vault +``` + +### Backups +Critical backups are stored in . Reconstructable data is stored in the volume. + +### Restore +```bash +cd services/swarm/stack/vault +./deploy.sh +``` + +--- + +## 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 | + +--- + +## Changelog + +| 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 | + + + +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 +- Source: swarm/vault.yaml +- Review User Guide and Changelog sections \ No newline at end of file