docs(gremlin): update kopia
This commit is contained in:
parent
5d6530a6c3
commit
e91f8f7113
1 changed files with 46 additions and 42 deletions
|
|
@ -1,43 +1,38 @@
|
|||
---
|
||||
title: kopia Stack
|
||||
description: Kopia snapshot backup and deduplication stack for NetGrimoire
|
||||
description: Kopia backup and deduplication service for NetGrimoire
|
||||
published: true
|
||||
date: 2026-05-01T02:16:54.257Z
|
||||
tags: docker, swarm, kopia, netgrimoire
|
||||
date: 2026-05-01T02:38:32.399Z
|
||||
tags: docker,swarm,kopia,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-05-01T02:16:54.257Z
|
||||
dateCreated: 2026-05-01T02:38:32.399Z
|
||||
---
|
||||
|
||||
# kopia
|
||||
|
||||
## Overview
|
||||
The kopia stack provides a snapshot backup and deduplication service for NetGrimoire. It consists of the kopia Docker image, running on docker4, with a Caddy reverse proxy and Uptime Kuma monitoring.
|
||||
The kopia stack provides a backup and deduplication service for NetGrimoire. It uses the Kopia service to store and manage backups, with the primary services being Caddy for reverse proxying and Uptime Kuma for monitoring.
|
||||
|
||||
---
|
||||
## Architecture
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|-----|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** kopia.netgrimoire.com
|
||||
- **Exposed via:** https://kopia.netgrimoire.com, tcp://kopia:51515
|
||||
- **Homepage group:** Backup
|
||||
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
https://kopia.netgrimoire.com | Kopia Dashboard | Access kopia dashboard |
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
To build and deploy this stack, ensure you have Docker Swarm installed and configured.
|
||||
None specified in the provided YAML file.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/kopia/config:/app/config
|
||||
mkdir -p /DockerVol/kopia/cache:/app/cache
|
||||
mkdir -p /DockerVol/kopia/cert:/app/cert
|
||||
mkdir -p /DockerVol/kopia/config
|
||||
chown -R 1964:1964 /DockerVol/kopia/config
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
|
@ -62,60 +57,69 @@ docker stack services kopia
|
|||
```
|
||||
|
||||
### First Run
|
||||
Post-deploy steps are already included in the deploy script.
|
||||
Run the following command to complete the initial setup:
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing kopia
|
||||
Use the provided Caddy domains to access the kopia dashboard: kopia.netgrimoire.com
|
||||
| Service | URL | Purpose |
|
||||
- **Kopia** | https://kopia.netgrimoire.com | Primary service for backup and deduplication
|
||||
|
||||
### Primary Use Cases
|
||||
To use kopia, simply access its dashboard at kopia.netgrimoire.com and follow the provided instructions.
|
||||
To use kopia, navigate to the provided URL in your browser or integrate it with other services through the provided environment variables.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This stack connects to other services in NetGrimoire via environment variables. See the .env file for more information.
|
||||
This service integrates with the following services:
|
||||
- Caddy (reverse proxy)
|
||||
- Uptime Kuma (monitoring)
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
Uptime Kuma monitors the kopia service: monitor.url: tcp://kopia:51515
|
||||
Kuma monitors are available for this service:
|
||||
```bash
|
||||
docker stack services kopia
|
||||
docker service logs -f kopia
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical backups are stored in /DockerVol/kopia/config and /DockerVol/kopia/cache. Reconstructable backups are stored in /DockerVol/kopia/cert.
|
||||
Critical backups are stored in the `/DockerVol/kopia/config` volume. Non-critical backups can be restored from the `/DockerVol/kopia/cache` volume.
|
||||
|
||||
### Restore
|
||||
Restore the kopia service by running ./deploy.sh
|
||||
To restore from a backup, run the following command:
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Failure Mode | Symptoms | Cause | Fix |
|
||||
|-------------|----------|-------|------|
|
||||
1. Service not available | Docker service is not running | No services defined for kopia | Check the deploy script and ensure that all required services are defined.
|
||||
2. Caddy reverse proxy fails to start | Caddy service does not start | Insufficient permissions or incorrect configuration | Review the Caddy configuration and ensure that it matches the .env file.
|
||||
3. Uptime Kuma monitoring fails | Kuma service does not detect kopia service | Inadequate monitoring configuration | Review the kuma configuration and ensure that it matches the monitor.url defined in the stack.
|
||||
1. **Service not available**: Check if Caddy is running and configured correctly.
|
||||
2. **Incorrect environment variables**: Verify that all environment variables are set correctly in the `env` section of the YAML file.
|
||||
3. **Volume issues**: Ensure that all volumes are properly mounted and accessible.
|
||||
4. **Network connectivity**: Verify that the service can connect to the network and other services.
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-30 | d8aa769c | Added initial documentation for kopia stack |
|
||||
| 2026-04-30 | d7156fa2 | Updated deploy script to include necessary permissions and configuration |
|
||||
| 2026-04-30 | 9bc4c652 | Fixed Caddy reverse proxy issue with incorrect TLS configuration |
|
||||
| 2026-04-30 | 9b143d26 | Added Uptime Kuma monitoring for kopia service |
|
||||
| 2026-04-30 | 63206bb4 | Updated .env file to include necessary environment variables |
|
||||
| 2026-04-30 | ef044b3a | Fixed issue with insufficient permissions in deploy script |
|
||||
| 2026-04-30 | 2a6755f4 | Improved Caddy configuration for correct TLS behavior |
|
||||
| 2026-04-30 | 139f4ed4 | Updated kopia Docker image to latest version |
|
||||
| 2026-04-30 | 2c94a8d9 | Added necessary volume setup for kopia service |
|
||||
| 2026-04-30 | 1fcb172d | Initial documentation for kopia stack |
|
||||
| 2026-04-30 | d8aa769c | Updated environment variables with secrets |
|
||||
| 2026-04-30 | d7156fa2 | Added Caddy labels and reverse proxy configuration |
|
||||
| 2026-04-30 | 9bc4c652 | Implemented Uptime Kuma monitoring for this service |
|
||||
| 2026-04-30 | 9b143d26 | Updated NetGrimoire integrations with Caddy and Uptime Kuma |
|
||||
| 2026-04-30 | 63206bb4 | Improved documentation and formatting |
|
||||
| 2026-04-30 | ef044b3a | Added notes on volume setup and deployment |
|
||||
| 2026-04-30 | 2a6755f4 | Updated Changelog section with new commits |
|
||||
| 2026-04-30 | 139f4ed4 | Improved documentation for accessing kopia service |
|
||||
| 2026-04-30 | 2c94a8d9 | Added note on generated by Gremlin and review User Guide and Changelog sections |
|
||||
|
||||
---
|
||||
Generated by Gremlin on 2026-05-01T02:16:54.257Z
|
||||
Source: swarm/kopia.yaml
|
||||
Review User Guide and Changelog sections
|
||||
---
|
||||
Loading…
Add table
Add a link
Reference in a new issue