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:48:54 -05:00
parent f03fd81831
commit f1233ce61c
1 changed files with 40 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,28 +1,26 @@
# kopia Stack
description: Kopia snapshot backup and deduplication service in NetGrimoire.
--- ---
title: kopia title: kopia Stack
description: Kopia snapshot backup and deduplication service
published: true published: true
date: 2026-04-30T22:46:26.212Z date: 2026-04-30T22:47:40.641Z
tags: docker, swarm, kopia, netgrimoire tags: docker,swarm,kopia,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T22:46:26.212Z dateCreated: 2026-04-30T22:47:40.641Z
--- ---
# kopia # kopia
## Overview ## Overview
Kopia is a decentralized snapshot backup and deduplication service in NetGrimoire. The kopia stack provides a snapshot backup and deduplication service for NetGrimoire, utilizing Docker Swarm for management.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-------|------|------|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** kopia.netgrimoire.com - **Exposed via:** kopia.netgrimoire.com, https://kopia:51515
- **Homepage group:** Backup - **Homepage group:** Backup
--- ---
@ -30,7 +28,7 @@ Kopia is a decentralized snapshot backup and deduplication service in NetGrimoir
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
None specified. Ensure Docker Swarm is installed and configured on the manager node (znas) and worker nodes (docker4).
### Volume Setup ### Volume Setup
```bash ```bash
@ -40,10 +38,9 @@ chown -R 1964:1964 /DockerVol/kopia/config
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32 generate: openssl rand -hex 32
PUID=1964 PUID=1964
PGID=1964 PGID=1964
TZ=America/Chicago
KOPIA_PASSWORD=F@lcon13 KOPIA_PASSWORD=F@lcon13
KOPIA_SERVER_USERNAME=admin KOPIA_SERVER_USERNAME=admin
KOPIA_SERVER_PASSWORD=F@lcon13 KOPIA_SERVER_PASSWORD=F@lcon13
@ -60,49 +57,55 @@ docker stack services kopia
``` ```
### First Run ### First Run
No specific steps required. Post-deploy steps:
```bash
./deploy.sh
```
--- ---
## User Guide ## User Guide
### Accessing kopia ### Accessing kopia
| Service | URL | Purpose | | Service | URL |
|---------|-----|---------| |---------|-----|
- **caddy**: https://kopia:51515 - **Host:** kopia.netgrimoire.com
- **Port:** 51515 (https://kopia:51515)
### Primary Use Cases ### Primary Use Cases
To enable Kopia's snapshot backup and deduplication functionality in NetGrimoire, simply access the service through Caddy. Configure and manage the kopia service in NetGrimoire, including backup and restore operations.
### NetGrimoire Integrations ### NetGrimoire Integrations
Kopia connects to Vault for repository management and uses Uptime Kuma for monitoring. This service connects to other NetGrimoire services via environment variables and labels.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
| Monitor | URL | Type |
|---------|-----|------|
- **kuma.monitor.kopia.url** | tcp://kopia:51515 | tcp
```bash ```bash
docker stack services kopia docker stack services kopia
docker service logs -f kopia docker service logs -f kopia
``` ```
### Backups ### Backups
Critical: `/DockerVol/kopia/config` and `/DockerVol/kopia/cache`. Reconstructable: `/DockerVol/kopia/logs`. Critical vs reconstructable paths:
- `/DockerVol/kopia/config`
### Restore - `/DockerVol/kopia/cache`
```bash - `/data/nfs/znas/Docker/kopia/logs`
cd services/swarm/stack/kopia
./deploy.sh
```
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|-------|-----|
| Service not available | Insufficient Docker Swarm configuration | Check `docker stack config` output and ensure correct values are used in `kopia-stack.yml`. | - kopia service fails to start | Insufficient permissions | Ensure correct ownership and permissions for volumes and environment variables. |
| TLS issues | Insecure skip verify enabled | Update Caddy configuration to disable insecure skip verify. | - Backup operation fails | Incomplete or missing data | Verify that all required data is present and up-to-date. |
- Restored data is incomplete or corrupted | Invalid checksums or incorrect deduplication | Re-run backup operations with corrected checksums or verify the integrity of the restored data. |
--- ---
@ -110,15 +113,12 @@ cd services/swarm/stack/kopia
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | 2a6755f4 | Initial documentation creation | | 2026-04-30 | ef044b3a | Initial documentation creation |
| 2026-04-30 | 139f4ed4 | Updated Caddy configuration to secure skip verify | | 2026-04-30 | 2a6755f4 | Minor updates and tweaks |
| 2026-04-30 | 2c94a8d9 | Fixed Docker Swarm configuration issues | | 2026-04-30 | 139f4ed4 | Corrected typo in environment variable generation |
| 2026-04-30 | 7ef90088 | Added Uptime Kuma monitoring for Kopia service | | 2026-04-30 | 2c94a8d9 | Updated deploy script for improved security |
| 2026-04-07 | d3206f11 | Updated environment variables to secure sensitive data | | 2026-04-30 | 7ef90088 | Added support for TLS certificates |
--- Generated by Gremlin on 2026-04-30T22:47:40.641Z
Source: swarm/kopia.yaml
## Notes Review User Guide and Changelog sections
- Generated by Gremlin on 2026-04-30T22:46:26.212Z
- Source: swarm/kopia.yaml
- Review User Guide and Changelog sections