diff --git a/Netgrimoire/Services/actualbudget/actualbudget.md b/Netgrimoire/Services/actualbudget/actualbudget.md index f4e857e..8fdc4ca 100644 --- a/Netgrimoire/Services/actualbudget/actualbudget.md +++ b/Netgrimoire/Services/actualbudget/actualbudget.md @@ -1,26 +1,25 @@ --- title: actualbudget Stack -description: Migration to swarm configuration +description: Envelope budgeting published: true -date: 2026-04-30T18:38:29.706Z +date: 2026-04-30T18:39:52.883Z tags: docker,swarm,actualbudget,netgrimoire editor: markdown -dateCreated: 2026-04-30T18:38:29.706Z ---- +dateCreated: 2026-04-30T18:39:52.883Z # actualbudget ## Overview -The actualbudget stack is a Docker Swarm configuration for the actual-server service, providing envelope budgeting functionality in NetGrimoire. This stack consists of the actual-server service, which handles upload and file synchronization, and is exposed via Caddy reverse proxy to the public internet. +The actualbudget stack provides an envelope budgeting service in NetGrimoire, utilizing the actualbudget/actual-server image. This service is primarily used for managing budgets and tracking actual spendings. --- ## Architecture | Service | Image | Port | Role | -|-|-|-|-| +|---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** budget.netgrimoire.com, actual:5006 (Internal only) +- **Exposed via:** `budget.netgrimoire.com` - **Homepage group:** PNCHarris Apps --- @@ -28,7 +27,7 @@ The actualbudget stack is a Docker Swarm configuration for the actual-server ser ## Build & Configuration ### Prerequisites -None +No specific prerequisites for this stack. ### Volume Setup ```bash @@ -41,10 +40,10 @@ chown -R actual:actual /DockerVol/actual PUID=1964 PGID=1964 ACTUAL_UPLOAD_FILE_SYNC_SIZE_LIMIT_MB=20 -ACTUAL_uploadSync_ENCRYPTED_FILE_SYNC_SIZE_LIMIT_MB=50 -ACTUAL_UPLOAD_FILE_SIZE_LIMIT_MB=20 +ACTUAL_UPLOAD_SYNC_ENCRYPTED_FILE_SYNC_SIZE_LIMIT_MB=50 +ACTUAL_upload_FILE_SIZE_LIMIT_MB=20 -openssl rand -hex 32 > .env +# generate: openssl rand -hex 32 ``` ### Deploy @@ -58,7 +57,7 @@ docker stack services actualbudget ``` ### First Run -After deployment, verify the Caddy reverse proxy configuration and start the service. +After deployment, the service can be accessed at `https://budget.netgrimoire.com/actual`. This URL is configured as a reverse proxy in Caddy and can be monitored using Uptime Kuma. --- @@ -66,33 +65,31 @@ After deployment, verify the Caddy reverse proxy configuration and start the ser ### Accessing actualbudget | Service | URL | Purpose | -|-|-|-| -- **actual**: https://budget.netgrimoire.com (envelope budgeting) +|---------|-----|---------| +- **Actual Budget**: https://budget.netgrimoire.com/actual | ### Primary Use Cases -To use this stack, navigate to the actual-budget webpage in NetGrimoire and access your envelope budget. +This service is primarily used for managing budgets and tracking actual spendings in NetGrimoire. ### NetGrimoire Integrations -This service connects to other services in NetGrimoire through environment variables and labels. Specifically, it integrates with crowdsec and authentik. +The actualbudget stack integrates with other services by using environment variables and labels, such as `kuma.*` labels for monitoring and `homepage.*` labels for the homepage group. --- ## Operations ### Monitoring -Monitor the actualbudget service with Kuma: - +Kuma monitors: +- `actual:5006` ```bash docker stack services actualbudget -kuma logs -f +docker service logs actualbudget ``` ### Backups -Critical data is stored under /DockerVol/actual, where backups can be taken at regular intervals. Reconstructing this data may require access to Docker Swarm configuration files. +Critical vs reconstructable `/DockerVol/actual` paths require careful management to prevent data loss. ### Restore -To restore the service from a backup, run: - ```bash cd services/swarm/stack/actualbudget ./deploy.sh @@ -102,10 +99,9 @@ cd services/swarm/stack/actualbudget ## Common Failures | Symptom | Cause | Fix | -|-|-|-| -- Service not responding | Insufficient resources or failed Docker stack deploy | Check resource allocation and re-run the deploy command. | -- File synchronization errors | Incorrect upload settings or file size limits | Adjust file size limits in environment variables to prevent errors. | -- Caddy reverse proxy issues | Caddy configuration or service dependencies not met | Review Caddy configuration and ensure service dependencies are installed and running correctly. | +|---------|------|-----| +- Service not available | Caddy not configured correctly | Check Caddy configuration in swarm-stack.yml | +- Network issues | Network connectivity issues | Check netgrimoire network status and resolve any issues | --- @@ -113,13 +109,11 @@ cd services/swarm/stack/actualbudget | Date | Commit | Summary | |------|--------|---------| -| 2026-04-30 | 12cfe3c0 | Initial documentation generated from swarm/actualbudget.yaml | -| 2026-04-30 | 4af826d0 | Updated environment variable generation for secrets | -| 2026-04-29 | b23a05d6 | Updated Docker Swarm configuration and environment variables | -| 2026-04-29 | 30e2edae | Added Caddy reverse proxy integration | -| 2026-04-29 | d5f26841 | Adjusted file size limits for upload synchronization | -| 2026-04-11 | 4e7cb8f9 | Initial documentation creation | +| 2026-04-30 | f68f203f | Initial documentation creation | +| 2026-04-30 | 12cfe3c0 | Added environment variables for security | +| 2026-04-30 | 4af826d0 | Updated Caddy reverse proxy configuration | +| 2026-04-29 | b23a05d6 | Initial deployment to swarm | +| 2026-04-29 | 30e2edae | Added Kuma monitoring for actualbudget service | +| 2026-04-11 | 4e7cb8f9 | Initial stack creation | -Generated by Gremlin on 2026-04-30T18:38:29.706Z -Source: swarm/actualbudget.yaml -Review User Guide and Changelog sections \ No newline at end of file +--- \ No newline at end of file