Netgrimoire/Netgrimoire/Services/actualbudget/actualbudget.md

3.1 KiB

title description published date tags editor dateCreated
actualbudget Stack Actual Budgeting Service for NetGrimoire true 2026-04-30T18:38:26.574Z docker,swarm,actualbudget,netgrimoire markdown 2026-04-30T18:38:26.574Z

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.

Architecture

Service Image Port Role
  • Host: docker4
  • Network: netgrimoire
  • Exposed via: budget.netgrimoire.com, actual:5006 (via Caddy reverse proxy)
  • Homepage group: PNCHarris Apps

Build & Configuration

Prerequisites

None specified in the configuration file.

Volume Setup

mkdir -p /DockerVol/actual
chown -R actual:actual /DockerVol/actual

Environment Variables

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

Deploy

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.sh script to initialize the service.


User Guide

Accessing actualbudget

Service URL Purpose

Primary Use Cases

Use the actualbudget application for envelope budgeting purposes within NetGrimoire.

NetGrimoire Integrations

The actualbudget service integrates with other services through environment variables and labels, such as:

  • Crowdsec: imported_1 and imported_2
  • Authentik: imported

Operations

Monitoring

Uptime Kuma monitors the actualbudget service:

docker stack services actualbudget
docker service logs -f actualbudget

Backups

Critical data is stored in /DockerVol/actual. Make sure to backup this volume regularly.

Restore

Run the ./deploy.sh script to restore the service from a previous state.


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

Changelog

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

Notes

  • Generated by Gremlin on 2026-04-30T18:38:26.574Z
  • Source: swarm/actualbudget.yaml
  • Review User Guide and Changelog sections