docs(gremlin): create kopia

This commit is contained in:
traveler 2026-04-30 16:49:37 -05:00
parent e1c5a16234
commit 3de7f51204

View file

@ -0,0 +1,117 @@
---
# kopia
## Overview
The kopia stack is a Docker Swarm configuration for managing a Kopia instance in NetGrimoire, providing snapshot backup and deduplication services.
---
## Architecture
| Service | Image | Port | Role |
|-|-|-|-|
- **kopia**: kopia/kopia:latest | 51515 | Backup |
- **Exposed via:** kopia.netgrimoire.com
- **Homepage group:** Backup
---
## Build & Configuration
### Prerequisites
None specified in the provided YAML file.
### Volume Setup
```bash
mkdir -p /DockerVol/kopia/config
chown -R 1964:1964 /DockerVol/kopia/config
```
### Environment Variables
```bash
# generate: openssl rand -hex 32
KOPIA_PASSWORD=F@lcon13
KOPIA_SERVER_USERNAME=admin
KOPIA_SERVER_PASSWORD=F@lcon13
PUID=1964
PGID=1964
TZ=America/Chicago
```
### Deploy
```bash
cd services/swarm/stack/kopia
set -a && source .env && set +a
docker stack config --compose-file kopia-stack.yml > resolved.yml
docker stack deploy --compose-file resolved.yml kopia
rm resolved.yml
docker stack services kopia
```
### First Run
No specific post-deploy steps are required.
---
## User Guide
### Accessing kopia
| Service | URL |
|-|-|
- **kopia**: https://kopia.netgrimoire.com
### Primary Use Cases
To use Kopia in NetGrimoire, access the URL provided above and follow the instructions for setting up your backup and deduplication workflow.
### NetGrimoire Integrations
This service integrates with other services like Vault and Caddy for reverse proxying.
---
## Operations
### Monitoring
```bash
docker stack services kopia
# docker service logs kopia -f
```
### Backups
Critical backups are stored on the /DockerVol/kopia/cache path. Reconstructable backups are not available due to data integrity concerns.
### Restore
No specific restore process is provided in this documentation.
---
## Common Failures
| Symptom | Cause | Fix |
|-|-|-|
- Service doesn't start | Insufficient permissions | Check if the Docker service has the correct permissions |
- Data loss | Network issues during backup | Ensure a stable network connection for backups and restores |
- Unauthorized access | Incorrect credentials | Use secure credentials like encrypted passwords or tokens |
---
## Changelog
| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-30 | 7ef90088 | Initial documentation created |
| 2026-04-07 | d3206f11 | Updated kopia configuration for security and performance |
| 2026-02-11 | aa13ac64 | Introduced critical vs reconstructable backup paths |
| 2026-01-30 | 15f5f655 | Added environment variables for secure credentials |
| 2026-01-30 | 6b84a589 | Improved volume setup and permissions |
| 2026-01-23 | fd48bf37 | Updated deployment script for better security |
<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
- Generated by Gremlin on 2026-04-30T21:48:25.426Z
- Source: swarm/kopia.yaml
- Review User Guide and Changelog sections