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-29 13:24:22 -05:00
parent 2b112ec73c
commit 317524e32f
1 changed files with 36 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,30 +1,32 @@
--- ---
title: actualbudget Stack title: actualbudget Stack
description: Envelope budgeting description: Migration to swarm configuration
published: true published: true
date: 2026-04-29T18:20:53.359Z date: 2026-04-29T18:20:56.503Z
tags: docker,swarm,actualbudget,netgrimoire tags: docker,swarm,actualbudget,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-29T18:20:53.359Z dateCreated: 2026-04-29T18:20:56.503Z
--- ---
# actualbudget # actualbudget
## Overview ## 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 ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-------|-----|------|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- Exposed via: budget.netgrimoire.com, actual:5006 (Caddy reverse proxy) - **Exposed via:** caddy-docker-proxy: actual:5006
- Homepage group: PNCHarris Apps - **Homepage group:** PNCHarris Apps
---
## Build & Configuration ## Build & Configuration
### Prerequisites ### 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 ### Volume Setup
```bash ```bash
@ -50,47 +52,54 @@ docker stack services actualbudget
``` ```
### First Run ### 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 ## User Guide
### Accessing actualbudget ### Accessing actualbudget
| Service | URL | Purpose | | Service | URL | Purpose |
- **Actual Budget**: https://budget.netgrimoire.com (Homepage) |---------|-----|---------|
- **Actual**: https://actual.netgrimoire.com (Internal only)
### Primary Use Cases ### 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 ## Operations
### Monitoring ### Monitoring
Check the Uptime Kuma monitors for the `kuma.actual.http.name: "Actual Budget"` label. `docker stack services actualbudget`
```bash ```bash
docker stack services actualbudget docker service logs actualbudget
``` ```
### Backups ### 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 ### Restore
To restore the stack, run the following command: Restore the service with `./deploy.sh`.
```bash
cd services/swarm/stack/actualbudget
./deploy.sh
```
---
## Common Failures ## 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. | Symptom | Cause | Fix |
- 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. |---------|-------|-----|
| 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 ## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-29 | a91a2ded | Initial documentation for the actualbudget Stack | | 2026-04-29 | 30e2edae | Migration to swarm configuration |
| 2026-04-11 | 4e7cb8f9 | Initial commit of swarm/actualbudget.yaml | | 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:56.503Z>
- Generated by Gremlin on 2026-04-29T18:20:53.359Z <Source: swarm/actualbudget.yaml>
- Source: swarm/actualbudget.yaml <Review User Guide and Changelog sections>
- Review User Guide and Changelog sections