diff --git a/Netgrimoire/Services/actualbudget/actualbudget.md b/Netgrimoire/Services/actualbudget/actualbudget.md index 2a8279f..f4e857e 100644 --- a/Netgrimoire/Services/actualbudget/actualbudget.md +++ b/Netgrimoire/Services/actualbudget/actualbudget.md @@ -1,24 +1,26 @@ --- title: actualbudget Stack -description: Actual Budgeting Service for NetGrimoire +description: Migration to swarm configuration published: true -date: 2026-04-30T18:38:26.574Z +date: 2026-04-30T18:38:29.706Z tags: docker,swarm,actualbudget,netgrimoire editor: markdown -dateCreated: 2026-04-30T18:38:26.574Z +dateCreated: 2026-04-30T18:38:29.706Z --- # actualbudget ## Overview -The actualbudget stack is a Docker Swarm service that provides an envelope budgeting application for NetGrimoire. It consists of the actual-server image, which handles upload and file operations. +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. + +--- ## Architecture | Service | Image | Port | Role | -|---------|-------|------|------| +|-|-|-|-| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** budget.netgrimoire.com, actual:5006 (via Caddy reverse proxy) +- **Exposed via:** budget.netgrimoire.com, actual:5006 (Internal only) - **Homepage group:** PNCHarris Apps --- @@ -26,7 +28,7 @@ The actualbudget stack is a Docker Swarm service that provides an envelope budge ## Build & Configuration ### Prerequisites -None specified in the configuration file. +None ### Volume Setup ```bash @@ -39,8 +41,10 @@ chown -R actual:actual /DockerVol/actual PUID=1964 PGID=1964 ACTUAL_UPLOAD_FILE_SYNC_SIZE_LIMIT_MB=20 -ACTUAL_UPLOAD_SYNC_ENCRYPTED_FILE_SYNC_SIZE_LIMIT_MB=50 +ACTUAL_uploadSync_ENCRYPTED_FILE_SYNC_SIZE_LIMIT_MB=50 ACTUAL_UPLOAD_FILE_SIZE_LIMIT_MB=20 + +openssl rand -hex 32 > .env ``` ### Deploy @@ -54,7 +58,7 @@ docker stack services actualbudget ``` ### First Run -Run the `./deploy.sh` script to initialize the service. +After deployment, verify the Caddy reverse proxy configuration and start the service. --- @@ -62,41 +66,46 @@ Run the `./deploy.sh` script to initialize the service. ### Accessing actualbudget | Service | URL | Purpose | -|---------|-----|---------| -- **actual**: https://budget.netgrimoire.com (via Caddy reverse proxy) +|-|-|-| +- **actual**: https://budget.netgrimoire.com (envelope budgeting) ### Primary Use Cases -Use the actualbudget application for envelope budgeting purposes within NetGrimoire. +To use this stack, navigate to the actual-budget webpage in NetGrimoire and access your envelope budget. ### NetGrimoire Integrations -The actualbudget service integrates with other services through environment variables and labels, such as: -- Crowdsec: imported_1 and imported_2 -- Authentik: imported +This service connects to other services in NetGrimoire through environment variables and labels. Specifically, it integrates with crowdsec and authentik. --- ## Operations ### Monitoring -Uptime Kuma monitors the actualbudget service: +Monitor the actualbudget service with Kuma: + ```bash docker stack services actualbudget -docker service logs -f actualbudget +kuma logs -f ``` ### Backups -Critical data is stored in /DockerVol/actual. Make sure to backup this volume regularly. +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. ### Restore -Run the `./deploy.sh` script to restore the service from a previous state. +To restore the service from a backup, run: + +```bash +cd services/swarm/stack/actualbudget +./deploy.sh +``` --- ## Common Failures | Symptom | Cause | Fix | -|---------|-------|-----| -| Service not available | Insufficient container health check retries | Increase retry limit in deployment configuration | -| Data loss | Incomplete backup or missing data volume | Verify backups and ensure data volume is present | +|-|-|-| +- 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. | --- @@ -104,15 +113,13 @@ Run the `./deploy.sh` script to restore the service from a previous state. | Date | Commit | Summary | |------|--------|---------| -| 2026-04-30 | 4af826d0 | Initial documentation creation | -| 2026-04-29 | b23a05d6 | Updated environment variables and deploy script | -| 2026-04-29 | 30e2edae | Added Caddy reverse proxy configuration | -| 2026-04-29 | d5f26841 | Improved volume setup and cleanup | -| 2026-04-29 | a91a2ded | Enhanced user guide and operations section | +| 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 | ---- - -## Notes -- Generated by Gremlin on 2026-04-30T18:38:26.574Z -- Source: swarm/actualbudget.yaml -- Review User Guide and Changelog sections \ No newline at end of file +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