plasmagoat/homelab
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

yay
Some checks failed
Test / tests (push) Failing after 1m31s
Details
/ OpenTofu (push) Successful in 9s
Details

Browse source
This commit is contained in:
plasmagoat 2025-07-30 02:13:32 +02:00
parent f9e276282a
commit 6ba25b90a9
6 changed files with 42 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

32
docs/README.md
View file

@ -2,8 +2,8 @@
> Auto-generated documentation for the homelab deployment
>
> Generated on: $(date -R)
> Source: $(pwd)
> Generated on: Wed, 30 Jul 2025 02:13:08 +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**: ons 30 jul 01:56:04 CEST 2025
- **Generated**: Wed, 30 Jul 2025 02:13:11 +0200
## 🛠️ Management Tools
@ -64,11 +64,35 @@ homelab-generate-docs /path/to/output
### GitHub Actions Example
```yaml
name: Generate Documentation
on:
push:
branches: [ main ]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: cachix/install-nix-action@v24
- name: Generate docs
run: nix develop --command homelab-generate-docs ./docs
- name: Commit docs
run: |
git add docs/
git commit -m "docs: update homelab documentation" || exit 0
git push
```
### Manual Generation
```bash
# From your homelab directory
nix develop
homelab-generate-docs ./docs
git add docs/ && git commit -m "Update docs"
```
---

2
docs/current-deployment.md
View file

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

2
docs/fleet-overview.md
View file

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

2
docs/nodes.md
View file

@ -2,7 +2,7 @@
> Detailed per-node configuration
>
> Generated on: Wed, 30 Jul 2025 01:55:38 +0200
> Generated on: Wed, 30 Jul 2025 02:12:50 +0200
## Node: photos

2
docs/services.md
View file

@ -2,7 +2,7 @@
> Complete service documentation with core options, feature integrations, and smart defaults
>
> Generated on: Wed, 30 Jul 2025 01:55:42 +0200
> Generated on: Wed, 30 Jul 2025 02:12:53 +0200
This document provides comprehensive documentation for homelab services, organized by:
- **Core Service Options**: The main service configuration