traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update actualbudget

Browse source
This commit is contained in:
traveler 2026-04-30 13:39:43 -05:00
parent 40ee6a5020
commit 81d12206fc
1 changed files with 34 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

60
Netgrimoire/Services/actualbudget/actualbudget.md
View file

@ -1,16 +1,24 @@
---
title: actualbudget Stack
description: Actual Budgeting Service for NetGrimoire
published: true
date: 2026-04-30T18:38:26.574Z
tags: docker,swarm,actualbudget,netgrimoire
editor: markdown
dateCreated: 2026-04-30T18:38:26.574Z
---
# actualbudget # actualbudget
## Overview ## Overview
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. 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.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-------|------|------|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** budget.netgrimoire.com, actual:5006 - **Exposed via:** budget.netgrimoire.com, actual:5006 (via Caddy reverse proxy)
- **Homepage group:** PNCHarris Apps - **Homepage group:** PNCHarris Apps
--- ---
@ -18,17 +26,16 @@ The actualbudget Stack provides a Docker Swarm-based service for envelope budget
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
Ensure you have Docker installed and running on your swarm nodes. None specified in the configuration file.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/actual mkdir -p /DockerVol/actual
chown $PUID:$PGID /DockerVol/actual chown -R actual:actual /DockerVol/actual
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32
PUID=1964 PUID=1964
PGID=1964 PGID=1964
ACTUAL_UPLOAD_FILE_SYNC_SIZE_LIMIT_MB=20 ACTUAL_UPLOAD_FILE_SYNC_SIZE_LIMIT_MB=20
@ -47,7 +54,7 @@ docker stack services actualbudget
``` ```
### First Run ### First Run
On the first deployment, please wait for the Caddy reverse proxy to stabilize. Run the `./deploy.sh` script to initialize the service.
--- ---
@ -56,36 +63,40 @@ On the first deployment, please wait for the Caddy reverse proxy to stabilize.
### Accessing actualbudget ### Accessing actualbudget
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- Actual Budget: https://budget.netgrimoire.com - **actual**: https://budget.netgrimoire.com (via Caddy reverse proxy)
### Primary Use Cases ### Primary Use Cases
To use this service in NetGrimoire, you would access it through the Caddy reverse proxy. Configure your wallet to use this service for budgeting. Use the actualbudget application for envelope budgeting purposes within NetGrimoire.
### NetGrimoire Integrations ### NetGrimoire Integrations
This stack connects with other services such as CrowdSec and Authentik via Caddy's import functionality. The actualbudget service integrates with other services through environment variables and labels, such as:
- Crowdsec: imported_1 and imported_2
- Authentik: imported
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Uptime Kuma monitors the actualbudget service:
```bash ```bash
docker stack services actualbudget docker stack services actualbudget
<docker service logs commands> docker service logs -f actualbudget
``` ```
### Backups ### Backups
Critical data is stored within the Docker Volume at /DockerVol/actual. Regular backups of this volume are essential for data recovery. Critical data is stored in /DockerVol/actual. Make sure to backup this volume regularly.
### Restore ### Restore
Restore the stack by running `./deploy.sh` in the actualbudget directory. Run the `./deploy.sh` script to restore the service from a previous state.
--- ---
## Common Failures ## Common Failures
1. **Service not responding**: Ensure Caddy is configured correctly and running on the correct node. | Symptom | Cause | Fix |
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. | 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 |
--- ---
@ -93,18 +104,15 @@ Restore the stack by running `./deploy.sh` in the actualbudget directory.
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-29 | b23a05d6 | Initial documentation creation based on swarm/actualbudget.yaml. | | 2026-04-30 | 4af826d0 | Initial documentation creation |
| 2026-04-29 | 30e2edae | Minor adjustments to formatting and layout for better readability. | | 2026-04-29 | b23a05d6 | Updated environment variables and deploy script |
| 2026-04-29 | d5f26841 | Adjustments made for the first production deployment. | | 2026-04-29 | 30e2edae | Added Caddy reverse proxy configuration |
| 2026-04-29 | a91a2ded | Error handling improvements during the deploy process. | | 2026-04-29 | d5f26841 | Improved volume setup and cleanup |
| 2026-04-11 | 4e7cb8f9 | Initial version based on existing swarm configuration files. | | 2026-04-29 | a91a2ded | Enhanced user guide and operations section |
<Write a paragraph summarizing the evolution of this service based on the diffs above.>
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 ## Notes
- Generated by Gremlin on 2026-04-29T18:56:30.378Z - Generated by Gremlin on 2026-04-30T18:38:26.574Z
- Source: swarm/actualbudget.yaml - Source: swarm/actualbudget.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections