From 4943c7c41bac5695a37da3e583e1b260eeae50dd Mon Sep 17 00:00:00 2001
From: Yuris Cakranegara <yuris_aryansyah@yahoo.com>
Date: Thu, 12 Jun 2025 21:21:09 +1000
Subject: [PATCH] feat(actualbudget): define publish_via config

---
 .../20-services-apps/actualbudget/README.md   | 77 +++++++++++++++++++
 modules/20-services-apps/actualbudget/main.tf |  1 +
 2 files changed, 78 insertions(+)
 create mode 100644 modules/20-services-apps/actualbudget/README.md

diff --git a/modules/20-services-apps/actualbudget/README.md b/modules/20-services-apps/actualbudget/README.md
new file mode 100644
index 0000000..a5a4a62
--- /dev/null
+++ b/modules/20-services-apps/actualbudget/README.md
@@ -0,0 +1,77 @@
+# ActualBudget Module
+
+This module deploys [ActualBudget](https://actualbudget.com/), a personal finance and budgeting application, as a Docker container in the homelab environment.
+
+## Overview
+
+The ActualBudget module:
+
+- Deploys the `actualbudget/actual-server` Docker container
+- Persists data to a volume on the host
+- Provides service definition for integration with networking modules
+
+## Usage
+
+```hcl
+module "actualbudget" {
+  source      = "./modules/20-services-apps/actualbudget"
+  volume_path = "/path/to/volumes/actualbudget"
+  networks    = ["homelab-network"]
+}
+```
+
+## Variables
+
+| Variable      | Description                                                | Type           | Default    |
+| ------------- | ---------------------------------------------------------- | -------------- | ---------- |
+| `image_tag`   | Tag of the ActualBudget image to use                       | `string`       | `"latest"` |
+| `volume_path` | Host path for ActualBudget data volume                     | `string`       | -          |
+| `networks`    | List of networks to which the container should be attached | `list(string)` | -          |
+
+## Outputs
+
+| Output               | Description                                                |
+| -------------------- | ---------------------------------------------------------- |
+| `service_definition` | Service definition for integration with networking modules |
+
+## Service Definition
+
+This module outputs a service definition that is used by the networking modules to expose the service.
+
+```hcl
+{
+  name         = "actualbudget"
+  primary_port = 5006
+  endpoint     = "http://actualbudget:5006"
+  subdomains   = ["budget"]
+  publish_via  = "tunnel"  # Only publish through Cloudflare tunnel
+}
+```
+
+## Data Persistence
+
+ActualBudget stores its data in the `/data` directory inside the container. This is mapped to a volume on the host at `${volume_path}/data`.
+
+## Integration with Networking Modules
+
+This service is configured to be exposed through a Cloudflare tunnel for secure remote access, set by `publish_via = "tunnel"`.
+
+## Example Integration in Main Configuration
+
+```hcl
+module "actualbudget" {
+  source      = "./modules/20-services-apps/actualbudget"
+  volume_path = module.system_globals.volume_host
+  networks    = [module.services.homelab_docker_network_name]
+}
+
+# The service definition is automatically included in the services output
+module "services" {
+  source = "./modules/services"
+  # ...
+  service_definitions = [
+    module.actualbudget.service_definition,
+    # Other service definitions
+  ]
+}
+```
diff --git a/modules/20-services-apps/actualbudget/main.tf b/modules/20-services-apps/actualbudget/main.tf
index 688ef63..cc9adf3 100644
--- a/modules/20-services-apps/actualbudget/main.tf
+++ b/modules/20-services-apps/actualbudget/main.tf
@@ -47,5 +47,6 @@ output "service_definition" {
     primary_port = local.exposed_port
     endpoint     = "http://${local.container_name}:${local.exposed_port}"
     subdomains    = local.subdomains
+    publish_via   = "tunnel"
   }
 }