docs(gremlin): create actualbudget
This commit is contained in:
parent
05808b40a5
commit
549255472b
1 changed files with 120 additions and 0 deletions
120
Netgrimoire/Services/actualbudget/actualbudget.md
Normal file
120
Netgrimoire/Services/actualbudget/actualbudget.md
Normal file
|
|
@ -0,0 +1,120 @@
|
||||||
|
# actualbudget Stack
|
||||||
|
description: Budgeting service for Actual
|
||||||
|
|
||||||
|
---
|
||||||
|
title: actualbudget Stack
|
||||||
|
description: <one line>
|
||||||
|
published: true
|
||||||
|
date: 2026-04-11T18:18:40.138Z
|
||||||
|
tags: docker,swarm,actualbudget,netgrimoire
|
||||||
|
editor: markdown
|
||||||
|
dateCreated: 2026-04-11T18:18:40.138Z
|
||||||
|
---
|
||||||
|
|
||||||
|
# actualbudget
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The actualbudget stack is a Docker Swarm service that provides an envelope budgeting solution for Actual in NetGrimoire.
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
| Service | Image | Port | Role |
|
||||||
|
|- **actual** | actualbudget/actual-server:latest | 5006 | Envelope Budgeting |
|
||||||
|
|
||||||
|
- **Host:** docker4
|
||||||
|
- **Network:** netgrimoire
|
||||||
|
- **Exposed via:** budget.netgrimoire.com
|
||||||
|
- **Homepage group:** Finance
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Build & Configuration
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
None specified.
|
||||||
|
|
||||||
|
### Volume Setup
|
||||||
|
```bash
|
||||||
|
mkdir -p /DockerVol/actual
|
||||||
|
chown -R actual:actual /DockerVol/actual
|
||||||
|
```
|
||||||
|
|
||||||
|
### Environment Variables
|
||||||
|
```bash
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
### Deploy
|
||||||
|
```bash
|
||||||
|
cd services/swarm/stack/actualbudget
|
||||||
|
set -a && source .env && set +a
|
||||||
|
docker stack config --compose-file actualbudget-stack.yml > resolved.yml
|
||||||
|
docker stack deploy --compose-file resolved.yml actualbudget
|
||||||
|
rm resolved.yml
|
||||||
|
docker stack services actualbudget
|
||||||
|
```
|
||||||
|
|
||||||
|
### First Run
|
||||||
|
Run the deploy script to initialize the service.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## User Guide
|
||||||
|
|
||||||
|
### Accessing actualbudget
|
||||||
|
| Service | URL | Purpose |
|
||||||
|
|- **actual** | budget.netgrimoire.com:5006 | Envelope Budgeting |
|
||||||
|
|
||||||
|
### Primary Use Cases
|
||||||
|
To use the actualbudget service, navigate to the URL provided in the user guide and follow the instructions for envelope budgeting.
|
||||||
|
|
||||||
|
### NetGrimoire Integrations
|
||||||
|
This service connects to other services through environment variables and labels. For a complete list of integrations, see the `env` file.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Operations
|
||||||
|
|
||||||
|
### Monitoring
|
||||||
|
```bash
|
||||||
|
docker stack services actualbudget
|
||||||
|
docker service logs -f actualbudget
|
||||||
|
```
|
||||||
|
|
||||||
|
### Backups
|
||||||
|
Critical: `/DockerVol/actual`
|
||||||
|
Reconstructable: `/DockerVol/actual`
|
||||||
|
|
||||||
|
### Restore
|
||||||
|
```bash
|
||||||
|
cd services/swarm/stack/actualbudget
|
||||||
|
./deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Common Failures
|
||||||
|
| Symptom | Cause | Fix |
|
||||||
|
|- | - | - |
|
||||||
|
| Service not starting | Incorrect deploy script | Review and correct the deploy script.|
|
||||||
|
| Data corruption | Insufficient backups | Regularly back up critical data using `docker stack services actualbudget` and `docker service logs -f actualbudget`.|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
|
| Date | Commit | Summary |
|
||||||
|
|- | - | - |
|
||||||
|
| 2026-04-11 | 4e7cb8f9 | Initial deployment of actualbudget stack |
|
||||||
|
|
||||||
|
<Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.>
|
||||||
|
|
||||||
|
The actualbudget stack has undergone changes with commit 4e7cb8f9, which marked its initial deployment in NetGrimoire.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Generated by Gremlin on 2026-04-11T18:18:40.138Z
|
||||||
|
- Source: swarm/actualbudget.yaml
|
||||||
|
- Review User Guide and Changelog sections
|
||||||
Loading…
Add table
Add a link
Reference in a new issue