updated docs
This commit is contained in:
parent
ce8c543e84
commit
73d2f44d74
14 changed files with 940 additions and 913 deletions
126
docs/services.md
126
docs/services.md
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
> Available services and their configuration options
|
||||
>
|
||||
> Generated on: tir 29 jul 16:25:43 CEST 2025
|
||||
> Generated on: $(date)
|
||||
|
||||
This document catalogs all available homelab services, their configuration options, and integration capabilities.
|
||||
|
||||
|
|
@ -10,6 +10,17 @@ This document catalogs all available homelab services, their configuration optio
|
|||
|
||||
**Total Available Services:** 4
|
||||
|
||||
## Service Integration Matrix
|
||||
|
||||
| Service | Monitoring | Logging | Proxy | Auth Default |
|
||||
|---------|------------|---------|-------|--------------|
|
||||
| `gatus` | ❌ | ❌ | ❌ | 🌐 |
|
||||
| `grafana` | ❌ | ❌ | ❌ | 🌐 |
|
||||
| `minio` | ❌ | ❌ | ❌ | 🌐 |
|
||||
| `prometheus` | ❌ | ❌ | ❌ | 🌐 |
|
||||
|
||||
**Legend:** ✅ = Enabled by default, ❌ = Available but disabled, 🔒 = Auth required, 🌐 = Public access
|
||||
|
||||
## Service Reference
|
||||
|
||||
### gatus
|
||||
|
|
@ -18,7 +29,15 @@ This document catalogs all available homelab services, their configuration optio
|
|||
|
||||
**Default Port:** `8080`
|
||||
|
||||
**Current Deployments:** 0 instance(s)
|
||||
**Current Deployments:** 0 instance(s) on:
|
||||
|
||||
#### Default Integration Status
|
||||
|
||||
| Integration | Status | Default Configuration |
|
||||
|-------------|--------|----------------------|
|
||||
| 📊 Monitoring | ❌ Disabled | Available but requires `monitoring.enable = true` |
|
||||
| 📝 Logging | ❌ Disabled | Available but requires `logging.enable = true` |
|
||||
| 🔀 Proxy | ❌ Disabled | Available but requires `proxy.enable = true` |
|
||||
|
||||
#### Core Configuration
|
||||
|
||||
|
|
@ -27,6 +46,11 @@ homelab.services.gatus = {
|
|||
enable = true;
|
||||
port = 8080;
|
||||
description = "Gatus Status Page";
|
||||
|
||||
# Default integrations (adjust as needed)
|
||||
# monitoring.enable = true; # ❌ Disabled by default
|
||||
# logging.enable = true; # ❌ Disabled by default
|
||||
# proxy.enable = true; # ❌ Disabled by default
|
||||
};
|
||||
```
|
||||
|
||||
|
|
@ -47,17 +71,6 @@ homelab.services.gatus = {
|
|||
};
|
||||
```
|
||||
|
||||
#### Complete Example
|
||||
|
||||
```nix
|
||||
# Full configuration example for gatus
|
||||
homelab.services.gatus = {
|
||||
enable = true;
|
||||
port = 8080;
|
||||
description = "Gatus Status Page";
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### grafana
|
||||
|
|
@ -66,7 +79,15 @@ homelab.services.gatus = {
|
|||
|
||||
**Default Port:** `3000`
|
||||
|
||||
**Current Deployments:** 0 instance(s)
|
||||
**Current Deployments:** 0 instance(s) on:
|
||||
|
||||
#### Default Integration Status
|
||||
|
||||
| Integration | Status | Default Configuration |
|
||||
|-------------|--------|----------------------|
|
||||
| 📊 Monitoring | ❌ Disabled | Available but requires `monitoring.enable = true` |
|
||||
| 📝 Logging | ❌ Disabled | Available but requires `logging.enable = true` |
|
||||
| 🔀 Proxy | ❌ Disabled | Available but requires `proxy.enable = true` |
|
||||
|
||||
#### Core Configuration
|
||||
|
||||
|
|
@ -75,17 +96,11 @@ homelab.services.grafana = {
|
|||
enable = true;
|
||||
port = 3000;
|
||||
description = "Grafana Metrics Dashboard";
|
||||
};
|
||||
```
|
||||
|
||||
#### Complete Example
|
||||
|
||||
```nix
|
||||
# Full configuration example for grafana
|
||||
homelab.services.grafana = {
|
||||
enable = true;
|
||||
port = 3000;
|
||||
description = "Grafana Metrics Dashboard";
|
||||
# Default integrations (adjust as needed)
|
||||
# monitoring.enable = true; # ❌ Disabled by default
|
||||
# logging.enable = true; # ❌ Disabled by default
|
||||
# proxy.enable = true; # ❌ Disabled by default
|
||||
};
|
||||
```
|
||||
|
||||
|
|
@ -97,7 +112,15 @@ homelab.services.grafana = {
|
|||
|
||||
**Default Port:** `9000`
|
||||
|
||||
**Current Deployments:** 1 instance(s)
|
||||
**Current Deployments:** 1 instance(s) on: photos
|
||||
|
||||
#### Default Integration Status
|
||||
|
||||
| Integration | Status | Default Configuration |
|
||||
|-------------|--------|----------------------|
|
||||
| 📊 Monitoring | ❌ Disabled | Available but requires `monitoring.enable = true` |
|
||||
| 📝 Logging | ❌ Disabled | Available but requires `logging.enable = true` |
|
||||
| 🔀 Proxy | ❌ Disabled | Available but requires `proxy.enable = true` |
|
||||
|
||||
#### Core Configuration
|
||||
|
||||
|
|
@ -106,6 +129,11 @@ homelab.services.minio = {
|
|||
enable = true;
|
||||
port = 9000;
|
||||
description = "minio";
|
||||
|
||||
# Default integrations (adjust as needed)
|
||||
# monitoring.enable = true; # ❌ Disabled by default
|
||||
# logging.enable = true; # ❌ Disabled by default
|
||||
# proxy.enable = true; # ❌ Disabled by default
|
||||
};
|
||||
```
|
||||
|
||||
|
|
@ -123,17 +151,6 @@ homelab.services.minio = {
|
|||
};
|
||||
```
|
||||
|
||||
#### Complete Example
|
||||
|
||||
```nix
|
||||
# Full configuration example for minio
|
||||
homelab.services.minio = {
|
||||
enable = true;
|
||||
port = 9000;
|
||||
description = "minio";
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### prometheus
|
||||
|
|
@ -142,7 +159,15 @@ homelab.services.minio = {
|
|||
|
||||
**Default Port:** `9090`
|
||||
|
||||
**Current Deployments:** 0 instance(s)
|
||||
**Current Deployments:** 0 instance(s) on:
|
||||
|
||||
#### Default Integration Status
|
||||
|
||||
| Integration | Status | Default Configuration |
|
||||
|-------------|--------|----------------------|
|
||||
| 📊 Monitoring | ❌ Disabled | Available but requires `monitoring.enable = true` |
|
||||
| 📝 Logging | ❌ Disabled | Available but requires `logging.enable = true` |
|
||||
| 🔀 Proxy | ❌ Disabled | Available but requires `proxy.enable = true` |
|
||||
|
||||
#### Core Configuration
|
||||
|
||||
|
|
@ -151,6 +176,11 @@ homelab.services.prometheus = {
|
|||
enable = true;
|
||||
port = 9090;
|
||||
description = "Prometheus Monitoring Server";
|
||||
|
||||
# Default integrations (adjust as needed)
|
||||
# monitoring.enable = true; # ❌ Disabled by default
|
||||
# logging.enable = true; # ❌ Disabled by default
|
||||
# proxy.enable = true; # ❌ Disabled by default
|
||||
};
|
||||
```
|
||||
|
||||
|
|
@ -174,28 +204,17 @@ homelab.services.prometheus = {
|
|||
};
|
||||
```
|
||||
|
||||
#### Complete Example
|
||||
|
||||
```nix
|
||||
# Full configuration example for prometheus
|
||||
homelab.services.prometheus = {
|
||||
enable = true;
|
||||
port = 9090;
|
||||
description = "Prometheus Monitoring Server";
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Integration Summary
|
||||
|
||||
### Available Integration Types
|
||||
|
||||
| Integration | Purpose | Configuration |
|
||||
|-------------|---------|---------------|
|
||||
| **Monitoring** | Prometheus metrics + health checks | `monitoring.enable = true` |
|
||||
| **Logging** | Centralized log collection | `logging.enable = true` |
|
||||
| **Proxy** | Reverse proxy with SSL + auth | `proxy.enable = true` |
|
||||
| Integration | Purpose | Default Behavior | Configuration |
|
||||
|-------------|---------|------------------|---------------|
|
||||
| **📊 Monitoring** | Prometheus metrics + health checks | Service-dependent | `monitoring.enable = true` |
|
||||
| **📝 Logging** | Centralized log collection | Service-dependent | `logging.enable = true` |
|
||||
| **🔀 Proxy** | Reverse proxy with SSL + auth | Service-dependent | `proxy.enable = true` |
|
||||
|
||||
### Integration Benefits
|
||||
|
||||
|
|
@ -203,6 +222,7 @@ homelab.services.prometheus = {
|
|||
- **📊 Unified Monitoring:** All metrics and health checks appear in Prometheus/Grafana
|
||||
- **📝 Centralized Logging:** All logs are collected and indexed in Loki
|
||||
- **🌐 Consistent Access:** All services get consistent subdomain access with SSL
|
||||
- **🎯 Smart Defaults:** Each service comes with sensible default configurations
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue