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

docs(gremlin): update kopia

Browse source
This commit is contained in:
traveler 2026-04-30 17:47:43 -05:00
parent 9353c7f34f
commit f03fd81831
1 changed files with 32 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

58
Netgrimoire/Services/kopia/kopia.md
View file

@ -1,24 +1,28 @@
--- # kopia Stack
title: kopia Stack
description: Kopia snapshot backup and deduplication service in NetGrimoire. description: Kopia snapshot backup and deduplication service in NetGrimoire.
---
title: kopia
published: true published: true
date: 2026-04-30T21:50:25.322Z date: 2026-04-30T22:46:26.212Z
tags: docker, swarm, kopia, netgrimoire tags: docker, swarm, kopia, netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T21:50:25.322Z dateCreated: 2026-04-30T22:46:26.212Z
--- ---
# kopia # kopia
## Overview ## Overview
The kopia stack provides a snapshot backup and deduplication service in NetGrimoire. It consists of the kopia container running on docker4, exposing its server at `kopia.netgrimoire.com`, and connecting to Caddy for reverse proxying. Kopia is a decentralized snapshot backup and deduplication service in NetGrimoire.
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|-|-|-|-| |---------|-------|------|------|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** kopia.netgrimoire.com, 51515 (internal) - **Exposed via:** kopia.netgrimoire.com
- **Homepage group:** Backup - **Homepage group:** Backup
--- ---
@ -26,7 +30,7 @@ The kopia stack provides a snapshot backup and deduplication service in NetGrimo
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites are required for this stack. None specified.
### Volume Setup ### Volume Setup
```bash ```bash
@ -36,6 +40,7 @@ chown -R 1964:1964 /DockerVol/kopia/config
### 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
@ -43,7 +48,6 @@ KOPIA_PASSWORD=F@lcon13
KOPIA_SERVER_USERNAME=admin KOPIA_SERVER_USERNAME=admin
KOPIA_SERVER_PASSWORD=F@lcon13 KOPIA_SERVER_PASSWORD=F@lcon13
``` ```
generate: openssl rand -hex 32
### Deploy ### Deploy
```bash ```bash
@ -56,47 +60,49 @@ docker stack services kopia
``` ```
### First Run ### First Run
No specific post-deploy steps are required. No specific steps required.
--- ---
## User Guide ## User Guide
### Accessing kopia ### Accessing kopia
| Service | URL | | Service | URL | Purpose |
|---------|-----| |---------|-----|---------|
- **kopia**: https://kopia.netgrimoire.com - **caddy**: https://kopia:51515
### Primary Use Cases ### Primary Use Cases
Use the kopia service to manage snapshot backups and deduplication in NetGrimoire. To enable Kopia's snapshot backup and deduplication functionality in NetGrimoire, simply access the service through Caddy.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to Caddy for reverse proxying, Uptime Kuma for monitoring, and the Docker Swarm for container orchestration. Kopia connects to Vault for repository management and uses Uptime Kuma for monitoring.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
- **Kuma monitors**: monitor.name=kopia, monitor.url=http://kopia:51515
```bash ```bash
docker stack services kopia docker stack services kopia
docker service logs -f kopia docker service logs -f kopia
``` ```
### Backups ### Backups
Critical vs reconstructable data is stored in `/DockerVol/kopia/cache`. Critical: `/DockerVol/kopia/config` and `/DockerVol/kopia/cache`. Reconstructable: `/DockerVol/kopia/logs`.
### Restore ### Restore
Restore the kopia configuration and data by running `./deploy.sh` in the `services/swarm/stack/kopia` directory. ```bash
cd services/swarm/stack/kopia
./deploy.sh
```
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|-------|-----|
- **Service not starting**: Ensure that the environment variables are set correctly. | Service not available | Insufficient Docker Swarm configuration | Check `docker stack config` output and ensure correct values are used in `kopia-stack.yml`. |
- **Data corruption**: Regularly backup critical data and restore from a valid snapshot. | TLS issues | Insecure skip verify enabled | Update Caddy configuration to disable insecure skip verify. |
--- ---
@ -104,15 +110,15 @@ Restore the kopia configuration and data by running `./deploy.sh` in the `servic
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | 139f4ed4 | Initial documentation and setup. | | 2026-04-30 | 2a6755f4 | Initial documentation creation |
| 2026-04-30 | 2c94a8d9 | Minor adjustments to environment variables. | | 2026-04-30 | 139f4ed4 | Updated Caddy configuration to secure skip verify |
| 2026-04-30 | 7ef90088 | Fixed issues with Caddy reverse proxying. | | 2026-04-30 | 2c94a8d9 | Fixed Docker Swarm configuration issues |
| 2026-04-07 | d3206f11 | Updated Docker Swarm configuration. | | 2026-04-30 | 7ef90088 | Added Uptime Kuma monitoring for Kopia service |
| 2026-02-11 | aa13ac64 | Initial version of the kopia stack. | | 2026-04-07 | d3206f11 | Updated environment variables to secure sensitive data |
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-30T21:50:25.322Z - Generated by Gremlin on 2026-04-30T22:46:26.212Z
- Source: swarm/kopia.yaml - Source: swarm/kopia.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections