traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update vault

Browse source
This commit is contained in:
traveler 2026-04-30 23:23:40 -05:00
parent ef6903e107
commit d2b7422300
1 changed files with 22 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

45
Netgrimoire/Services/vault/vault.md
View file

@ -2,23 +2,24 @@
title: vault Stack title: vault Stack
description: Kopia-Vault snapshot backup and deduplication description: Kopia-Vault snapshot backup and deduplication
published: true published: true
date: 2026-05-01T04:21:24.218Z date: 2026-05-01T04:21:29.154Z
tags: docker,swarm,vault,netgrimoire tags: docker,swarm,vault,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-05-01T04:21:24.218Z dateCreated: 2026-05-01T04:21:29.154Z
--- ---
# vault # vault
## Overview ## 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 ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|-----|------| |---------|-------|-----|------|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** <https://kopia:51516> (Caddy) - **Exposed via:** https://kopia:51516
- **Homepage group:** Backup - **Homepage group:** Backup
--- ---
@ -26,12 +27,12 @@ The vault stack provides a Kopia-Vault instance for snapshot backup and deduplic
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
None None specified.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/vault/config mkdir -p /DockerVol/vault/config
chown -R 1964:1964 /DockerVol/vault/config chown -R vault:vault /DockerVol/vault/config
``` ```
### Environment Variables ### Environment Variables
@ -55,7 +56,7 @@ docker stack services vault
``` ```
### First Run ### 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 ### Accessing vault
| Service | URL | Purpose | | 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 ### Primary Use Cases
To use this service, navigate to <https://192.168.5.10:51516> in your browser. Use this service to store and manage backups for critical data.
### NetGrimoire Integrations ### 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 ### Monitoring
```bash ```bash
docker stack services vault docker stack services vault
docker service logs -f vault docker service logs vault
``` ```
### Backups ### Backups
Critical backups are stored in <https://vault:51516/backup/>. Reconstructable data is stored in the <https://vault:51516/cache/> volume. Critical backups are stored in `/DockerVol/vault/config` and are reconstructable from the server's logs.
### Restore ### Restore
```bash ```bash
@ -96,10 +97,12 @@ cd services/swarm/stack/vault
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|--------|------|-----| |---------|------|-----|
| Service does not start | Insufficient permissions for the user `1964` | Ensure correct permissions are set in the Docker stack configuration | | <unknown> | <unknown> | <unknown> |
| Network issues | Caddy is not exposed to the network | Check if the Caddy service is correctly exposed and labeled | | <unknown> | <unknown> | <unknown> |
| Monitoring failures | Uptime Kuma is not monitoring the vault service | Restart the vault service and check Uptime Kuma logs for errors | | <unknown> | <unknown> | <unknown> |
| <unknown> | <unknown> | <unknown> |
| <unknown> | <unknown> | <unknown> |
--- ---
@ -107,17 +110,13 @@ cd services/swarm/stack/vault
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | 72833207 | Initial documentation created with correct service configuration | - No available diffs for this stack.
| 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 |
<Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.> <The `vault` stack has its initial documentation. Further updates and changes will be tracked in the Changelog section.>
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 ## 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 - Source: swarm/vault.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections