Files
docs/index.md
Nicole Rappe 554c04aa32
All checks were successful
Automatic Documentation Deployment / Sync Docs to https://kb.bunny-lab.io (push) Successful in 5s
Documentation Restructure
2026-02-27 04:02:06 -07:00

44 lines
1.7 KiB
Markdown

# Home
## Homelab Documentation Structure
This documentation details the design, setup, and day-to-day management of my homelab environment. The goal is to keep it deterministic, CLI-first, and easy to audit or reproduce. Some of the decisions made may not involve using the best security practices. Use your own discretion when following this documentation.
---
## Top-Level Sections
**Deployments**
- Platform, service, and automation deployment guides
**Workflows**
- Day-2 runbooks, maintenance procedures, and troubleshooting flows
**Scripts**
- Quick-use Bash, PowerShell, and Batch scripts/snippets
**Reference**
- Foundations, hardware inventory, and networking reference material
**Blog**
- Narrative posts and lessons learned
---
## ⚠️ Disclaimers & Scope
!!! warning "Homelab-Specific Guidance"
- **Personal Environment:** These docs reflect my own environment, goals, and risk tolerance.
- **Security & Scale:** Approaches described here are suited to homelab or SMB use, and may need adjustments for enterprise-scale, regulatory compliance, or higher security standards.
- **No Credentials:** All sensitive info is redacted or generalized.
- **Assumptions:** Some guides assume specific tools, e.g. [Portainer](deployments/platforms/containerization/docker/deploy-portainer.md), [AWX](./deployments/automation/ansible/awx/deployment/awx-operator.md), etc. Substitute with your preferred tools as needed.
---
## ✨ Quick Start
- Use the navigation panel to explore categories or search for keywords.
- Each section is designed to be modular and self-contained.
- Feedback and suggestions are always welcome.
---
> _“Homelabs are for learning, breaking things, and sharing the journey. Hope you find something helpful here!”_