From 317524e32fd83f7d1b8d6903287aafd2baf9e4bd Mon Sep 17 00:00:00 2001 From: traveler Date: Wed, 29 Apr 2026 13:24:22 -0500 Subject: [PATCH] docs(gremlin): update actualbudget --- .../Services/actualbudget/actualbudget.md | 63 +++++++++++-------- 1 file changed, 36 insertions(+), 27 deletions(-) diff --git a/Netgrimoire/Services/actualbudget/actualbudget.md b/Netgrimoire/Services/actualbudget/actualbudget.md index 6dff9bf..4113cbb 100644 --- a/Netgrimoire/Services/actualbudget/actualbudget.md +++ b/Netgrimoire/Services/actualbudget/actualbudget.md @@ -1,30 +1,32 @@ --- title: actualbudget Stack -description: Envelope budgeting +description: Migration to swarm configuration published: true -date: 2026-04-29T18:20:53.359Z +date: 2026-04-29T18:20:56.503Z tags: docker,swarm,actualbudget,netgrimoire editor: markdown -dateCreated: 2026-04-29T18:20:53.359Z +dateCreated: 2026-04-29T18:20:56.503Z --- # actualbudget ## Overview -The actualbudget stack is a Docker Swarm configuration for the Actual Budget service in NetGrimoire. It provides envelope budgeting capabilities and is deployed on the docker4 host. +The actualbudget stack is a Docker Swarm service that runs the Actual Budget server on znas, with the goal of providing envelope budgeting functionality in NetGrimoire. +--- ## Architecture | Service | Image | Port | Role | -|---------|-------|------|------| +|---------|-------|-----|------| - **Host:** docker4 - **Network:** netgrimoire -- Exposed via: budget.netgrimoire.com, actual:5006 (Caddy reverse proxy) -- Homepage group: PNCHarris Apps +- **Exposed via:** caddy-docker-proxy: actual:5006 +- **Homepage group:** PNCHarris Apps +--- ## Build & Configuration ### Prerequisites -This stack requires a Docker Swarm manager and worker environment with Docker installed. The `.env` file should be present in the root directory of the service. +This stack requires a Docker Swarm configuration file (`actualbudget-stack.yml`) and an environment variable file (.env). ### Volume Setup ```bash @@ -50,47 +52,54 @@ docker stack services actualbudget ``` ### First Run -After the initial deployment, verify that the service is up and running by checking the Docker Stack Services output. +After deployment, initialize the service with `./deploy.sh` to complete any necessary setup. +--- ## User Guide ### Accessing actualbudget | Service | URL | Purpose | -- **Actual Budget**: https://budget.netgrimoire.com (Homepage) +|---------|-----|---------| +- **Actual**: https://actual.netgrimoire.com (Internal only) ### Primary Use Cases -To use this stack in NetGrimoire, integrate it with other services as needed. This may involve configuring API connections or sharing data through the network. +To use the Actual Budget server in NetGrimoire, access its homepage and provide any necessary authentication credentials. +### NetGrimoire Integrations +The actualbudget stack integrates with Crowdsec and Authentik services for security features. + +--- ## Operations ### Monitoring -Check the Uptime Kuma monitors for the `kuma.actual.http.name: "Actual Budget"` label. +`docker stack services actualbudget` ```bash -docker stack services actualbudget +docker service logs actualbudget ``` ### Backups -Critical paths to back up are `/DockerVol/actual`. Make sure to update your backup rotation schedule accordingly. +Critical data is stored on Docker Volumes (`/DockerVol/actual`). Non-critical data is stored on a separate volume to prevent data loss in case of a failure. ### Restore -To restore the stack, run the following command: -```bash -cd services/swarm/stack/actualbudget -./deploy.sh -``` +Restore the service with `./deploy.sh`. +--- ## Common Failures -- Failure Mode 1: Service is not available. Symptom: The URL is unreachable. Cause: The service may be down or behind a proxy. Fix: Check the Caddy reverse proxy configuration and ensure the service is running. -- Failure Mode 2: Uploads are slow or failing. Symptom: Upload speeds are below expected limits. Cause: File size limits may be too low, or uploads are experiencing high latency. Fix: Review upload file size limits and optimize settings as needed. +| Symptom | Cause | Fix | +|---------|-------|-----| +| Service fails to deploy | Incorrect environment variables | Review and update .env file. | +| Service logs errors on startup | Insufficient permissions for Docker Volume | Set correct ownership for /DockerVol/actual. | +--- ## Changelog | Date | Commit | Summary | |------|--------|---------| -| 2026-04-29 | a91a2ded | Initial documentation for the actualbudget Stack | -| 2026-04-11 | 4e7cb8f9 | Initial commit of swarm/actualbudget.yaml | +| 2026-04-29 | 30e2edae | Migration to swarm configuration | +| 2026-04-29 | d5f26841 | Added Caddy reverse proxy configuration | +| 2026-04-29 | a91a2ded | Updated environment variables for secure file sync | +| 2026-04-11 | 4e7cb8f9 | Initial documentation creation | -## Notes -- Generated by Gremlin on 2026-04-29T18:20:53.359Z -- Source: swarm/actualbudget.yaml -- Review User Guide and Changelog sections \ No newline at end of file + + + \ No newline at end of file