Major documentation restructure - consolidated docs
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
New Structure: - 01-NETWORK-MAP.md - Network topology, IPs, Docker networks, services - 02-SERVICES-CRITICAL.md - DNS, Auth, Routing (P0/P1 services) - 03-SERVICES-OTHER.md - All non-critical services - 04-HARDWARE-INVENTORY.md - Physical devices and specs - 05-CHANGELOG.md - Major events only New Folders: - docs/archive/ - Legacy docs (read-only reference) - docs/wip/ - Planned changes and ideas - UPGRADE-2026-HARDWARE.md - N5 Air + N100 migration plan - GITOPS-CONTAINERS.md - Phase 2 container GitOps Changes: - Moved all 22 legacy docs to archive/ - Consolidated container IPs, physical map, and services into single network map - Extracted critical vs non-critical service classification - Simplified changelog to major events only Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
98
README.md
98
README.md
@@ -1,31 +1,83 @@
|
||||
# XTRM-Lab Infrastructure
|
||||
# XTRM Home Lab Infrastructure
|
||||
|
||||
This repository contains infrastructure documentation and CI/CD pipelines for the xtrm-lab.org homelab.
|
||||
**Domain:** xtrm-lab.org
|
||||
**Repository:** https://git.xtrm-lab.org/jazzymc/infrastructure
|
||||
|
||||
## Documentation
|
||||
---
|
||||
|
||||
All infrastructure documentation is in the `docs/` folder:
|
||||
## Quick Reference
|
||||
|
||||
| Document | Description |
|
||||
|----------|-------------|
|
||||
| [00-CURRENT-STATE.md](docs/00-CURRENT-STATE.md) | Current infrastructure state |
|
||||
| [01-PHASE1-DNS-PORTABILITY.md](docs/01-PHASE1-DNS-PORTABILITY.md) | DNS & Pi-hole setup |
|
||||
| [02-PHASE2-FOSSORIAL-STACK.md](docs/02-PHASE2-FOSSORIAL-STACK.md) | Pangolin tunnel stack |
|
||||
| [03-PHASE3-AUTHENTIK-ZEROTRUST.md](docs/03-PHASE3-AUTHENTIK-ZEROTRUST.md) | Authentik SSO |
|
||||
| [04-PHASE4-REMOTE-GAMING.md](docs/04-PHASE4-REMOTE-GAMING.md) | Sunshine/Moonlight |
|
||||
| [05-PHASE5-RUSTDESK.md](docs/05-PHASE5-RUSTDESK.md) | RustDesk setup |
|
||||
| [06-PHASE6-PORTAINER-MANAGEMENT.md](docs/06-PHASE6-PORTAINER-MANAGEMENT.md) | Portainer |
|
||||
| [08-PHASE7-GITEA-GITOPS.md](docs/08-PHASE7-GITEA-GITOPS.md) | Gitea & Woodpecker CI |
|
||||
| Resource | Address |
|
||||
|----------|---------|
|
||||
| **Dashboard** | https://xtrm-lab.org |
|
||||
| **NetBox** | https://netbox.xtrm-lab.org |
|
||||
| **Git** | https://git.xtrm-lab.org |
|
||||
| **CI/CD** | https://ci.xtrm-lab.org |
|
||||
| **DNS Primary** | dns.xtrm-lab.org |
|
||||
| **DNS Secondary** | dns2.xtrm-lab.org |
|
||||
|
||||
---
|
||||
|
||||
## Documentation Structure
|
||||
|
||||
```
|
||||
docs/
|
||||
├── 01-NETWORK-MAP.md # Network topology, IPs, Docker networks
|
||||
├── 02-SERVICES-CRITICAL.md # DNS, Auth, Routing - must stay up
|
||||
├── 03-SERVICES-OTHER.md # All other services
|
||||
├── 04-HARDWARE-INVENTORY.md # Physical devices, specs, serials
|
||||
├── 05-CHANGELOG.md # Major events only
|
||||
├── wip/ # Planned changes & ideas
|
||||
│ ├── UPGRADE-2026-HARDWARE.md
|
||||
│ └── GITOPS-CONTAINERS.md
|
||||
└── archive/ # Legacy docs (read-only)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Key Devices
|
||||
|
||||
| Device | IP | Role |
|
||||
|--------|-----|------|
|
||||
| HAP1 | 192.168.31.1 | Router, DNS, WiFi Controller |
|
||||
| XTRM-U | 192.168.31.2 | Production Server (Unraid) |
|
||||
| CSS1 | 192.168.31.9 | Distribution Switch |
|
||||
| ZX1 | 192.168.31.7 | Core Switch (2.5G) |
|
||||
| CAP | 192.168.31.6 | Wireless Access Point |
|
||||
|
||||
---
|
||||
|
||||
## SSH Access
|
||||
|
||||
```bash
|
||||
# Unraid
|
||||
ssh -i ~/.ssh/id_ed25519_unraid root@192.168.31.2 -p 422
|
||||
|
||||
# MikroTik Router
|
||||
ssh -i ~/.ssh/mikrotik_key -p 2222 unraid@192.168.31.1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Emergency Recovery
|
||||
|
||||
1. **DNS down?** → Clients fallback to 192.168.31.4 (secondary)
|
||||
2. **Internet down?** → Check HAP1 at 192.168.31.1
|
||||
3. **Services down?** → Check Unraid at 192.168.31.2
|
||||
4. **Full outage?** → See `02-SERVICES-CRITICAL.md` startup order
|
||||
|
||||
---
|
||||
|
||||
## Change Management
|
||||
|
||||
- **Major changes:** Document in `05-CHANGELOG.md`
|
||||
- **Minor changes:** Git commit messages only
|
||||
- **Planned work:** Create doc in `wip/` folder
|
||||
|
||||
---
|
||||
|
||||
## CI/CD
|
||||
|
||||
This repo uses Woodpecker CI. See [.woodpecker.yml](.woodpecker.yml) for the pipeline configuration.
|
||||
Woodpecker CI at https://ci.xtrm-lab.org
|
||||
|
||||
## Services
|
||||
|
||||
| Service | URL |
|
||||
|---------|-----|
|
||||
| Gitea | https://git.xtrm-lab.org |
|
||||
| Woodpecker CI | https://ci.xtrm-lab.org |
|
||||
| Authentik | https://auth.xtrm-lab.org |
|
||||
| Traefik | https://traefik.xtrm-lab.org |
|
||||
Pipelines trigger on push to this repository.
|
||||
|
||||
Reference in New Issue
Block a user