homelab/docs/README.md
plasmagoat ce8c543e84
Some checks failed
Test / tests (push) Has been cancelled
/ OpenTofu (push) Has been cancelled
auto docs
2025-07-29 16:28:17 +02:00

1.8 KiB

Homelab Documentation

Auto-generated documentation for the homelab deployment

Generated on: tir 29 jul 16:25:52 CEST 2025 Source: /home/plasmagoat/homelab

📚 Documentation Files

This documentation is automatically generated from your colmena flake configuration.

📊 Overview Documents

📖 Detailed Configuration

🚀 Quick Actions

View Current Status

# Service status across fleet (if homelab CLI is available)
homelab services --global

# Backup status
homelab backups --global

# Overall status
homelab status

Update Documentation

# Regenerate all documentation
homelab-generate-docs ./docs

# Generate in different directory
homelab-generate-docs /path/to/output

📋 Quick Stats

  • Total Nodes: 2
  • Homelab-Enabled Nodes: 2
  • Generated: tir 29 jul 16:25:55 CEST 2025

🛠️ Management Tools

Documentation Commands

  • homelab-generate-docs - Regenerate this documentation
  • homelab-docs-fleet - Generate fleet overview only
  • homelab-docs-nodes - Generate node configurations only
  • homelab-docs-services - Generate service configurations only
  • homelab-docs-deployment - Generate deployment state only

Colmena Commands

  • colmena eval - Evaluate flake expressions
  • colmena apply - Deploy configuration changes
  • colmena build - Build configurations without deploying

This documentation reflects the live state of your homelab deployment as evaluated by colmena.