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 23:10:23 -05:00
parent d65a92362f
commit 834f665fa2
1 changed files with 38 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,25 +1,27 @@
--- # kopia Stack
title: kopia Stack
description: Kopia snapshot backup and deduplication service in NetGrimoire description: Snapshot backup and deduplication
published: true published: true
date: 2026-05-01T04:07:50.455Z date: 2026-05-01T04:08:28.592Z
tags: docker,swarm,kopia,netgrimoire tags: docker,swarm,kopia,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-05-01T04:07:50.455Z dateCreated: 2026-05-01T04:08:28.592Z
--- ---
# kopia
## Overview ## Overview
The kopia stack is a Docker Swarm service that provides snapshot backup and deduplication capabilities in NetGrimoire. The kopia Stack is a Docker Swarm deployment that provides snapshot backup and deduplication capabilities in NetGrimoire. It consists of the Kopia service, which runs on docker4, and is exposed via the caddy reverse proxy. The stack includes critical services such as Uptime Kuma for monitoring and Docker volumes for data storage.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-----|-----|---------|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** https://kopia:51515,Internal only - **Exposed via:** https://kopia.kopia.network
- **Homepage group:** Backup - **Homepage group:** Backup
--- ---
@ -32,19 +34,15 @@ No specific prerequisites are required for this stack.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/kopia/config mkdir -p /DockerVol/kopia/config
chown -R kopia:kopia /DockerVol/kopia/config
mkdir -p /DockerVol/kopia/cache mkdir -p /DockerVol/kopia/cache
chown -R kopia:kopia /DockerVol/kopia/cache
mkdir -p /DockerVol/kopia/cert mkdir -p /DockerVol/kopia/cert
chown -R kopia:kopia /DockerVol/kopia/cert chown -R 1964:1964 /DockerVol/kopia/
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# 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
@ -61,7 +59,9 @@ docker stack services kopia
``` ```
### First Run ### First Run
After deploying the service, ensure that the Docker volumes are mounted and the environment variables are set. ```bash
./deploy.sh
```
--- ---
@ -70,40 +70,47 @@ After deploying the service, ensure that the Docker volumes are mounted and the
### Accessing kopia ### Accessing kopia
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- **kopia**: https://192.168.5.10:51515, access kopia dashboard - Kopia | https://kopia.kopia.network | Snapshot backup and deduplication
### Primary Use Cases ### Primary Use Cases
Use the kopia service to manage snapshot backups and deduplication for NetGrimoire. To use the kopia Stack, follow these steps:
1. Ensure Docker is installed and running on docker4.
2. Access the Kopia web interface at `https://kopia.kopia.network`.
3. Create a new user account with the provided credentials.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service integrates with other NetGrimoire services through environment variables and labels. The kopia Stack integrates with other services in NetGrimoire via environment variables and labels. Specifically, it connects to Uptime Kuma for monitoring and uses Docker volumes for data storage.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Uptime Kuma monitors the kopia service at `tcp://kopia:51515`.
```bash ```bash
docker stack services kopia docker stack services kopia
kuma monitor -t tcp://kopia:51515 docker service logs -f kopia
``` ```
### Backups ### Backups
Critical backup paths are stored in the `/DockerVol/kopia/config` volume. Ensure that this volume is mounted correctly during deployment. Critical data is stored in `/DockerVol/kopia/cache/` and can be restored by redeploying the service.
### Restore ### Restore
To restore a backup, run the following command: To restore the kopia service, follow these steps:
```bash
./deploy.sh 1. Redeploy the service using `./deploy.sh`.
``` 2. Ensure all critical data is present in the `/DockerVol/kopia/cache/` directory.
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|------|-----|
- Service not starting | Incorrect environment variables | Check and correct .env file | | No Kopia UI | Incorrect credentials | Check environment variables and ensure correct login credentials. |
- Docker volume mounting error | Insecure mount options | Update docker-stack.yml to include secure mount options | | Service not running | Inadequate restart policy | Review `docker stack deploy --compose-file resolved.yml kopia` command for errors. |
--- ---
@ -111,17 +118,13 @@ To restore a backup, run the following command:
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | 2c2da04c | Initial documentation creation | | 2026-04-30 | <inferred changes from diffs above> |
| 2026-04-30 | 11630569 | Updated environment variables |
| 2026-04-30 | c96ddaf6 | Fixed Docker volume mounting issue |
| 2026-04-30 | 305a9f61 | Improved security configuration |
| 2026-04-30 | 1fcb172d | Enhanced monitoring capabilities |
<The initial documentation for the kopia stack was created on 2026-04-30. The stack has undergone several updates since then, including improvements to environment variables and Docker volume mounting. Additional security measures have also been implemented to enhance the overall stability of the service.> <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.]
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-05-01T04:07:50.455Z - Generated by Gremlin on 2026-05-01T04:08:28.592Z
- Source: swarm/kopia.yaml - Source: swarm/kopia.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections