dump

docs/README.md

@@ -2,7 +2,7 @@
 
 > Auto-generated documentation for the homelab deployment
 >
-> Generated on: Wed, 30 Jul 2025 02:13:08 +0200
+> Generated on: Wed, 30 Jul 2025 02:30:55 +0200
 > Source: /home/plasmagoat/homelab
 
 ## 📚 Documentation Files
@@ -44,7 +44,7 @@ homelab-generate-docs /path/to/output
 
 - **Total Nodes**: 2
 - **Homelab-Enabled Nodes**: 2
-- **Generated**: Wed, 30 Jul 2025 02:13:11 +0200
+- **Generated**: Wed, 30 Jul 2025 02:30:59 +0200
 
 ## 🛠️ Management Tools
 

docs/current-deployment.md

@@ -2,7 +2,7 @@
 
 > Current homelab deployment configuration
 >
-> Generated on: Wed, 30 Jul 2025 02:13:01 +0200
+> Generated on: Wed, 30 Jul 2025 02:30:45 +0200
 > Working directory: /home/plasmagoat/homelab
 
 ## Deployment Summary

docs/fleet-overview.md

@@ -2,7 +2,7 @@
 
 > Auto-generated fleet overview
 >
-> Generated on: Wed, 30 Jul 2025 02:12:41 +0200
+> Generated on: Wed, 30 Jul 2025 02:30:24 +0200
 > Source: /home/plasmagoat/homelab
 
 ## Fleet Statistics

docs/nodes.md

@@ -2,7 +2,7 @@
 
 > Detailed per-node configuration
 >
-> Generated on: Wed, 30 Jul 2025 02:12:50 +0200
+> Generated on: Wed, 30 Jul 2025 02:30:33 +0200
 
 ## Node: photos
 
@@ -29,6 +29,7 @@
 
 | Service | Enabled | Port | Description | Tags |
 |---------|---------|------|-------------|------|
+| `example` | ❌ | 1234 | Example Homelab Service |  |
 | `gatus` | ❌ | 8080 | Gatus Status Page |  |
 | `grafana` | ❌ | 3000 | Grafana Metrics Dashboard |  |
 | `minio` | ✅ | 9000 | minio |  |
@@ -61,6 +62,7 @@
 
 | Service | Enabled | Port | Description | Tags |
 |---------|---------|------|-------------|------|
+| `example` | ❌ | 1234 | Example Homelab Service |  |
 | `gatus` | ✅ | 8080 | Gatus Status Page |  |
 | `grafana` | ✅ | 3000 | Grafana Metrics Dashboard |  |
 | `minio` | ❌ | 9000 | minio |  |

docs/services.md

@@ -2,7 +2,7 @@
 
 > Complete service documentation with core options, feature integrations, and smart defaults
 >
-> Generated on: Wed, 30 Jul 2025 02:12:53 +0200
+> Generated on: Wed, 30 Jul 2025 02:30:36 +0200
 
 This document provides comprehensive documentation for homelab services, organized by:
 - **Core Service Options**: The main service configuration
@@ -11,12 +11,13 @@ This document provides comprehensive documentation for homelab services, organiz
 
 ## Overview
 
-**Total Available Services:** 4
+**Total Available Services:** 5
 
 ## Service Integration Matrix
 
 | Service | Core Options | Monitoring | Logging | Proxy | Deployments |
 |---------|--------------|------------|---------|-------|-------------|
+| `example` | 5 | 📊 | 📝 | 🔀 | 0 |
 | `gatus` | 11 | 📊 | 📝 | 🔀 | 1 |
 | `grafana` | 3 | 📊 | 📝 | 🔀 | 1 |
 | `minio` | 4 | ❌ | ❌ | ❌ | 1 |
@@ -26,6 +27,112 @@ This document provides comprehensive documentation for homelab services, organiz
 
 ## Service Documentation
 
+### example
+
+**Deployment Status:** 0/2 nodes have this service enabled
+
+#### Core Service Options
+
+The main configuration options for example:
+
+```nix
+homelab.services.example = {
+  description = Example Homelab Service;  # No description
+  enable = false;  # Whether to enable Example Homelab Service.
+  openFirewall = true;  # Whether to open the ports specified in `port` and `webPort` in the firewall.
+  port = 1234;  # No description
+  systemdServices = [
+  "example.service",
+  "example"
+];  # Systemd services to monitor
+};
+```
+
+#### Feature Integrations
+
+##### 📊 Monitoring Integration
+
+Available monitoring options:
+
+```nix
+homelab.services.example = {
+  # ... core options above ...
+
+  monitoring.enable = true;  # Enable monitoring for example
+  monitoring.extraLabels = {};  # No description
+  monitoring.healthCheck.conditions = [
+  "[STATUS] == 200"
+];  # Health check conditions. Setting conditions enables health checks.
+  monitoring.healthCheck.enable = true;  # No description
+  monitoring.healthCheck.extraChecks = [];  # Additional health checks. Adding checks enables health monitoring.
+  # monitoring.healthCheck.path = <null or string>;  # Health check endpoint path. Setting this enables health checks.
+  monitoring.metrics.enable = false;  # No description
+  monitoring.metrics.extraEndpoints = [];  # Additional metrics endpoints. Adding endpoints enables metrics collection.
+  # monitoring.metrics.path = <null or string>;  # Metrics endpoint path. Setting this enables metrics collection.
+};
+```
+
+**example sets these monitoring defaults:**
+```nix
+  enable = true;
+  extraLabels = {};
+  healthCheck = {"conditions":["[STATUS] == 200"],"enable":true,"extraChecks":[],"path":null};
+  metrics = {"enable":false,"extraEndpoints":[],"path":null};
+```
+
+##### 📝 Logging Integration
+
+Available logging options:
+
+```nix
+homelab.services.example = {
+  # ... core options above ...
+
+  logging.enable = false;  # Enable logging for example
+  logging.extraLabels = {};  # No description
+  logging.extraSources = [];  # No description
+  logging.files = [];  # No description
+  # logging.multiline = <null or (submodule)>;  # No description
+  logging.parsing.extractFields = [];  # No description
+  # logging.parsing.regex = <null or string>;  # No description
+};
+```
+
+**example sets these logging defaults:**
+```nix
+  enable = false;
+  extraLabels = {};
+  extraSources = [];
+  files = [];
+  multiline = null;
+  parsing = {"extractFields":[],"regex":null};
+```
+
+##### 🔀 Proxy Integration
+
+Available proxy options:
+
+```nix
+homelab.services.example = {
+  # ... core options above ...
+
+  proxy.additionalSubdomains = [];  # No description
+  proxy.enable = true;  # Enable reverse proxy for example
+  proxy.enableAuth = false;  # No description
+  proxy.subdomain = example;  # No description
+};
+```
+
+**example sets these proxy defaults:**
+```nix
+  additionalSubdomains = [];
+  enable = true;
+  enableAuth = false;
+  subdomain = example;
+```
+
+---
+
 ### gatus
 
 **Deployment Status:** 1/2 nodes have this service enabled