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-05-01 08:10:30 -05:00
parent d2b7422300
commit 5f3aa7d22b
1 changed files with 34 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,42 +1,42 @@
--- ---
title: vault Stack title: vault Stack
description: Kopia-Vault snapshot backup and deduplication description: Kopia Vault Services in NetGrimoire
published: true published: true
date: 2026-05-01T04:21:29.154Z date: 2026-05-01T13:09:07.428Z
tags: docker,swarm,vault,netgrimoire tags: docker,swarm,vault,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-05-01T04:21:29.154Z dateCreated: 2026-05-01T13:09:07.428Z
--- ---
# vault # vault
## Overview ## Overview
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. The `vault` stack in NetGrimoire provides a secure Kopia Vault service for snapshot backup and deduplication. This stack consists of the `vault` Docker service, which is configured to run on `znas`.
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|-----|------| |---------|-------|------|------|
- **Host:** docker4 | Host | docker4 | | NetGrimoire Node |
- **Network:** netgrimoire | Network | netgrimoire | | Internal |
- **Exposed via:** https://kopia:51516
- **Homepage group:** Backup
--- Exposed via: <https://kopia-vault.192.168.5.10>, `tcp://kopia:51516`
Homepage group: Backup
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
None specified. You need Docker installed on your system to use this stack.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/vault/config mkdir -p /DockerVol/vault/config
chown -R vault:vault /DockerVol/vault/config mkdir -p /DockerVol/vault/cache
mkdir -p /DockerVol/vault/cert
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32
PUID=1964 PUID=1964
PGID=1964 PGID=1964
TZ=America/Chicago TZ=America/Chicago
@ -56,35 +56,33 @@ docker stack services vault
``` ```
### First Run ### First Run
Run the `./deploy.sh` script after deployment. Run `./deploy.sh` after initial deployment for the first time.
---
## User Guide ## User Guide
### Accessing vault ### Accessing vault
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- **Kopia-Vault** | https://kopia:51516 | Snapshot backup and deduplication | - **Host:** <https://kopia-vault.192.168.5.10>
- **Internal only:** <http://kopia:51516>
### Primary Use Cases ### Primary Use Cases
Use this service to store and manage backups for critical data. This stack provides a secure Kopia Vault service for snapshot backup and deduplication.
### NetGrimoire Integrations ### NetGrimoire Integrations
This stack integrates with other services through environment variables and labels, including Caddy, Uptime Kuma, and Homepage. This stack connects to other services via the `netgrimoire` network, using environment variables like `KOPIA_SERVER_USERNAME` and `KOPIA_SERVER_PASSWORD`.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
```bash | Monitor Name | Monitor URL |
docker stack services vault |-|-|
docker service logs vault - **Kuma**: <http://kopia:51516>
```
### Backups ### Backups
Critical backups are stored in `/DockerVol/vault/config` and are reconstructable from the server's logs. Critical data is stored in `/DockerVol/vault/cache`. All data can be reconstructed from backups stored in `/DockerVol/vault/backup/repository`.
### Restore ### Restore
```bash ```bash
@ -95,14 +93,10 @@ cd services/swarm/stack/vault
--- ---
## Common Failures ## Common Failures
| Failure | Symptom | Cause | Fix |
| Symptom | Cause | Fix | |-|-|-|-|
|---------|------|-----| - **No connection to Kopia Vault** | No response from vault service. | The vault service is not running. | `docker stack services vault` and inspect logs for issues.
| <unknown> | <unknown> | <unknown> | - **Kopia server credentials missing**: Error accessing vault due to invalid credentials. | The Kopia server username or password is incorrect or absent in the environment variables. | Double check that `KOPIA_SERVER_USERNAME` and `KOPIA_SERVER_PASSWORD` are set correctly.
| <unknown> | <unknown> | <unknown> |
| <unknown> | <unknown> | <unknown> |
| <unknown> | <unknown> | <unknown> |
| <unknown> | <unknown> | <unknown> |
--- ---
@ -110,13 +104,17 @@ cd services/swarm/stack/vault
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
- No available diffs for this stack. | 2026-04-30 | 6f7c6f87 | <infer what changed from the diffs above> |
| 2026-04-30 | 72833207 | <infer what changed from the diffs above> |
| 2026-02-22 | 573a7d8f | <infer what changed from the diffs above> |
| 2026-02-13 | 7b2ad934 | <infer what changed from the diffs above> |
| 2026-02-13 | 9209aa98 | <infer what changed from the diffs above> |
<The `vault` stack has its initial documentation. Further updates and changes will be tracked in the Changelog section.> This is the initial documentation for the `vault` stack in NetGrimoire.
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-05-01T04:21:29.154Z - Generated by Gremlin on 2026-05-01T13:09:07.428Z
- Source: swarm/vault.yaml - Source: swarm/vault.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections