55 lines
2.0 KiB
Markdown
55 lines
2.0 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
|
|
**Foundations**
|
|
- Conventions, templates, glossary, and shared standards
|
|
|
|
**Hardware**
|
|
- Node build sheets, storage layouts, and physical inventory
|
|
|
|
**Networking**
|
|
- Addressing plans, firewall rules, VPNs, and network services
|
|
|
|
**Platforms**
|
|
- Virtualization and containerization stacks (hypervisors, Kubernetes, Docker)
|
|
|
|
**Services**
|
|
- Deployable apps and services (auth, docs, email, monitoring, etc.)
|
|
|
|
**Automation**
|
|
- Ansible, Puppet, and workflow automation notes
|
|
|
|
**Operations**
|
|
- Runbooks for maintenance, backups, and troubleshooting
|
|
|
|
**Reference**
|
|
- Quick scripts and snippets for day-to-day tasks
|
|
|
|
**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](./platforms/containerization/docker/deploy-portainer.md), [AWX](./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!”_
|