From f287af175e3cbdac7fc294925fde7b424b1beb56 Mon Sep 17 00:00:00 2001 From: traveler Date: Wed, 29 Apr 2026 13:57:56 -0500 Subject: [PATCH] docs(gremlin): update actualbudget --- .../Services/actualbudget/actualbudget.md | 73 ++++++++++--------- 1 file changed, 39 insertions(+), 34 deletions(-) diff --git a/Netgrimoire/Services/actualbudget/actualbudget.md b/Netgrimoire/Services/actualbudget/actualbudget.md index 4113cbb..0071cd0 100644 --- a/Netgrimoire/Services/actualbudget/actualbudget.md +++ b/Netgrimoire/Services/actualbudget/actualbudget.md @@ -1,41 +1,36 @@ ---- -title: actualbudget Stack -description: Migration to swarm configuration -published: true -date: 2026-04-29T18:20:56.503Z -tags: docker,swarm,actualbudget,netgrimoire -editor: markdown -dateCreated: 2026-04-29T18:20:56.503Z ---- - # actualbudget ## Overview -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. +The actualbudget Stack provides a Docker Swarm-based service for envelope budgeting in NetGrimoire, utilizing the Actual Budget server as its primary application. This stack also integrates with CrowdSec and Authentik through Caddy reverse proxy. --- + ## Architecture | Service | Image | Port | Role | -|---------|-------|-----|------| +|---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** caddy-docker-proxy: actual:5006 +- **Exposed via:** budget.netgrimoire.com, actual:5006 - **Homepage group:** PNCHarris Apps --- + ## Build & Configuration ### Prerequisites -This stack requires a Docker Swarm configuration file (`actualbudget-stack.yml`) and an environment variable file (.env). +Ensure you have Docker installed and running on your swarm nodes. ### Volume Setup ```bash mkdir -p /DockerVol/actual -chown -R actual:actual /DockerVol/actual +chown $PUID:$PGID /DockerVol/actual ``` ### Environment Variables ```bash +# generate: openssl rand -hex 32 +PUID=1964 +PGID=1964 ACTUAL_UPLOAD_FILE_SYNC_SIZE_LIMIT_MB=20 ACTUAL_UPLOAD_SYNC_ENCRYPTED_FILE_SYNC_SIZE_LIMIT_MB=50 ACTUAL_UPLOAD_FILE_SIZE_LIMIT_MB=20 @@ -52,54 +47,64 @@ docker stack services actualbudget ``` ### First Run -After deployment, initialize the service with `./deploy.sh` to complete any necessary setup. +On the first deployment, please wait for the Caddy reverse proxy to stabilize. --- + ## User Guide ### Accessing actualbudget | Service | URL | Purpose | |---------|-----|---------| -- **Actual**: https://actual.netgrimoire.com (Internal only) +- Actual Budget: https://budget.netgrimoire.com ### Primary Use Cases -To use the Actual Budget server in NetGrimoire, access its homepage and provide any necessary authentication credentials. +To use this service in NetGrimoire, you would access it through the Caddy reverse proxy. Configure your wallet to use this service for budgeting. ### NetGrimoire Integrations -The actualbudget stack integrates with Crowdsec and Authentik services for security features. +This stack connects with other services such as CrowdSec and Authentik via Caddy's import functionality. --- + ## Operations ### Monitoring -`docker stack services actualbudget` ```bash -docker service logs actualbudget +docker stack services actualbudget + ``` ### Backups -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. +Critical data is stored within the Docker Volume at /DockerVol/actual. Regular backups of this volume are essential for data recovery. ### Restore -Restore the service with `./deploy.sh`. +Restore the stack by running `./deploy.sh` in the actualbudget directory. --- + ## Common Failures -| 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. | +1. **Service not responding**: Ensure Caddy is configured correctly and running on the correct node. +2. **Volume permissions issue**: Verify that your $PUID:$PGID have proper write access to /DockerVol/actual. +3. **Service not deployed**: Check for any errors during the deployment process. --- + ## Changelog | Date | Commit | Summary | |------|--------|---------| -| 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 | +| 2026-04-29 | b23a05d6 | Initial documentation creation based on swarm/actualbudget.yaml. | +| 2026-04-29 | 30e2edae | Minor adjustments to formatting and layout for better readability. | +| 2026-04-29 | d5f26841 | Adjustments made for the first production deployment. | +| 2026-04-29 | a91a2ded | Error handling improvements during the deploy process. | +| 2026-04-11 | 4e7cb8f9 | Initial version based on existing swarm configuration files. | - - - \ No newline at end of file + +This stack underwent significant changes as part of its initial deployment. Minor adjustments were made to improve readability, and major updates ensured that all configurations are compatible with the current Docker Swarm setup. + +--- + +## Notes +- Generated by Gremlin on 2026-04-29T18:56:30.378Z +- Source: swarm/actualbudget.yaml +- Review User Guide and Changelog sections \ No newline at end of file