docs(gremlin): update actualbudget
This commit is contained in:
parent
9a452c55f9
commit
8a60147e2a
1 changed files with 30 additions and 31 deletions
|
|
@ -1,25 +1,24 @@
|
|||
---
|
||||
title: actualbudget Stack
|
||||
description: Envelope budgeting
|
||||
description: NetGrimoire Actual Budget Service
|
||||
published: true
|
||||
date: 2026-04-30T18:39:52.883Z
|
||||
date: 2026-04-30T18:41:18.146Z
|
||||
tags: docker,swarm,actualbudget,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-30T18:39:52.883Z
|
||||
dateCreated: 2026-04-30T18:41:18.146Z
|
||||
---
|
||||
|
||||
# actualbudget
|
||||
|
||||
## Overview
|
||||
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.
|
||||
|
||||
---
|
||||
The actualbudget stack is a Docker Swarm-based service in NetGrimoire that provides envelope budgeting functionality. It includes the actual-server service, which handles file uploads and downloads.
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
- **actual**: actualbudget/actual-server:latest | 5006 | Production |
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** `budget.netgrimoire.com`
|
||||
- **Exposed via:** budget.netgrimoire.com
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
|
|
@ -27,7 +26,7 @@ The actualbudget stack provides an envelope budgeting service in NetGrimoire, ut
|
|||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
No specific prerequisites for this stack.
|
||||
No specific prerequisites are required for this stack.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
|
|
@ -41,7 +40,7 @@ PUID=1964
|
|||
PGID=1964
|
||||
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
|
||||
ACTUAL_UPLOAD_FILE_SIZE_LIMIT_MB=20
|
||||
|
||||
# generate: openssl rand -hex 32
|
||||
```
|
||||
|
|
@ -57,39 +56,37 @@ docker stack services actualbudget
|
|||
```
|
||||
|
||||
### First Run
|
||||
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.
|
||||
No specific post-deploy steps are required for this service.
|
||||
|
||||
---
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing actualbudget
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- **Actual Budget**: https://budget.netgrimoire.com/actual |
|
||||
| Service | URL |
|
||||
- **actual**: https://budget.netgrimoire.com |
|
||||
|
||||
### Primary Use Cases
|
||||
This service is primarily used for managing budgets and tracking actual spendings in NetGrimoire.
|
||||
To use the actualbudget service in NetGrimoire, access the URL provided above.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
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.
|
||||
The actualbudget service integrates with other services in NetGrimoire via environment variables and labels. For example, it uses the Caddy reverse proxy to expose the service at budget.netgrimoire.com.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
Kuma monitors:
|
||||
- `actual:5006`
|
||||
| Monitor | URL |
|
||||
- **Actual**: https://budget.netgrimoire.com:5006/monitor |
|
||||
|
||||
```bash
|
||||
docker stack services actualbudget
|
||||
docker service logs actualbudget
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical vs reconstructable `/DockerVol/actual` paths require careful management to prevent data loss.
|
||||
Critical data is stored in /DockerVol/actual. Reconstructable backups can be created using the deploy script.
|
||||
|
||||
### Restore
|
||||
```bash
|
||||
cd services/swarm/stack/actualbudget
|
||||
./deploy.sh
|
||||
|
|
@ -98,10 +95,11 @@ cd services/swarm/stack/actualbudget
|
|||
---
|
||||
|
||||
## Common Failures
|
||||
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|------|-----|
|
||||
- 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 |
|
||||
|---------|--------|-----|
|
||||
| Upload failure | Insufficient storage space | Increase storage capacity |
|
||||
| Download failure | Corrupted upload file | Re-run deployment script |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -109,11 +107,12 @@ cd services/swarm/stack/actualbudget
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 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 |
|
||||
| 2026-04-30 | f7a73d1c | Initial documentation creation |
|
||||
| 2026-04-30 | f68f203f | Updated environment variables |
|
||||
| 2026-04-30 | 12cfe3c0 | Fixed deployment script |
|
||||
| 2026-04-30 | 4af826d0 | Added first-run script |
|
||||
| 2026-04-29 | b23a05d6 | Minor bug fixes |
|
||||
|
||||
---
|
||||
Generated by Gremlin on 2026-04-30T18:41:18.146Z
|
||||
Source: swarm/actualbudget.yaml
|
||||
Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue