Home Lab Documentation // Tools Tips and Tricks!

Main ideas / lessons

• Home lab documentation is worth it because home labs are always changing. You’ll need to troubleshoot, reproduce setups, reinforce learning, find patterns for automation, and build production-like habits.
• Documentation has multiple layers:
  • Inventory (what you own and how it’s configured)
  • Diagrams (how things are wired and interconnected)
  • Config/code storage (source-controlled infrastructure and app configs)
  • A home lab wiki / knowledge base (where you store write-ups and one-off fixes)
  • Network-specific records (VLANs, subnets, DHCP, NAT/firewall rules, Wi‑Fi, etc.)
  • Operational practices (change logs, labeling, backups, and offline access)
• Automation can produce documentation automatically when you use infrastructure-as-code and config management tools with Git and READMEs.
• Resilience matters: plan for what happens when the lab is offline, and keep offline/replicated copies.

---

Methods & instructions (detailed checklist)

1) Start with an inventory (what to track)

List all hardware and software components, including:

• Host names
• IP addresses
• MAC addresses
• Make/model
• Serial numbers
• Firmware and BIOS versions
• Drivers
• OS versions
• Services currently running
• Physical location (room/rack info)

2) Track networking details early (network documentation essentials)

For each network segment, include:

• VLAN IDs and what they’re used for
• Subnets
• Reserved ranges
• DHCP scopes
• Static IP assignments
• Firewall and NAT rules
• Wi‑Fi SSIDs and (noted) passwords

3) Use tools suited to your documentation style

• Spreadsheets for simpler environments:
  • Google Sheets or Excel
• Network/IP management tools for deeper tracking:
  • PHP IPAM (personally used)
  • NetBox
• Diagramming for visual recall:
  • diagrams.net / draw.io
  • Excalidraw / net excaladraw
  • Lucidchart (noted as having a polished free tier)
  • Obsidian Canvas (if using Obsidian)
  • Microsoft Visio (for network topology like LAN/WAN and VLANs)
• Config/code version control for “the heart of the lab”:
  • Use Git with private repos on GitHub/GitLab/Gitea (or self-hosted alternatives)
  • Store examples such as:
    • pfSense / OpenSense firewall rules
    • Docker Compose files
    • Kubernetes manifests
    • Ansible playbooks
    • Proxmox VM configs
  • Use VS Code as an editor with built-in Git support
• Home lab wiki / “second brain” for write-ups:
  • wiki.js
  • BookStack
  • DocuWiki
  • Obsidian (for docs)
  • HedgeDoc
  • GitBook (commercial, with a free tier for a single user)

4) Document useful content (what to write)

Create and save:

• How-to guides
• Troubleshooting steps
• OS install notes
• Container configuration details
• Upgrade logs
• Anything that “burned an hour” so you don’t repeat the effort later

5) Add monitoring/scanning for ongoing device visibility (optional but recommended)

Use tools such as:

• UniFi Controller (includes topology mapping)
• Nmap (security scanning / discovery)
• Arpwatch (to track observed MAC/IP changes)
• Note: Arpwatch running in a container was referenced.

6) Leverage infrastructure as code to document by default (automation-as-documentation)

Use infrastructure/config tools and store everything in Git with READMEs:

• Terraform (declarative infrastructure)
• Ansible (config management)
• Packer (build VM images)

Benefit emphasized: when code is versioned and annotated, documentation exists as part of the workflow and becomes “transparent.”

7) Maintain backups of documentation (so you don’t lose it)

Keep secondary copies in:

• Cloud storage (Drive, Dropbox, S3, etc.)
• External drives (cheap, possibly used with Rust/Borg)
• NAS snapshots (Synology/TRNA mentioned)

Also:

• Run scheduled backup jobs for documentation folders.
• Keep a physical printout.

8) Keep a physical reference for break-glass situations

Example practice:

• Print/take a picture from UniFi controller showing switch ports:
  • which device is linked
  • VLAN associated

Goal: avoid confusion when the network breaks and you must unplug/reconnect fast.

9) Label physical gear and cabling

Label items such as:

• Ethernet cables (label both ends)
• Power cords
• Server names
• VLAN tags
• Storage bays

Rationale: prevent accidentally unplugging the wrong uplink/server (avoid “entire network down” scenarios).

Label printer mentioned:

• do lettag label printer (brand referenced)

10) Track changes over time with a change log (high-priority practice)

Create a simple change log.md file and record:

• Date
• What changed
• Why it changed / purpose
• How big the change was (no matter how small/large)
• Who made the change (especially if more than one person)
• Problems caused by the change (if any)

Instruction emphasized:

• Do documentation at the time of change (“front end”), not later.

11) Plan for offline/self-hosting failures (access docs when the lab is down)

Ensure you can access documentation even if the lab’s systems are offline. Approaches mentioned:

• Keep basic docs physically in the server rack (VLANs/uplinks/cabling context)
• If self-hosted:
  • sync Markdown/wikis to another location (SyncThing mentioned)
  • build a static site (e.g., MKDocs + Nginx) and host outside the lab if possible
• Keep cloud/external backups (reiterated)
• Keep multiple hard copies in different locations (1–3 suggested)

---

Mentioned tools / systems (grouped)

• Inventory / IP / networking records
  • Google Sheets, Excel
  • PHP IPAM (personal use)
  • NetBox
• Diagrams
  • diagrams.net (draw.io), Excalidraw
  • Lucidchart (free tier noted)
  • Obsidian Canvas
  • Microsoft Visio
• Config storage & coding
  • Git, GitHub, GitLab, Gitea (implied by “Git T”)
  • VS Code
• Home lab wiki / documentation
  • wiki.js, BookStack, DocuWiki
  • Obsidian, HedgeDoc
  • GitBook
• Network topology & scanning
  • UniFi Controller (topology mapper)
  • Nmap
  • Arpwatch (containerized option mentioned)
• Automation / infra-as-code
  • Terraform, Ansible, Packer
• Backups / storage
  • Cloud drives (Dropbox, S3, etc.)
  • External drives + Rustic/Borg (name referenced as Rustic/Borg)
  • NAS snapshots (Synology, “TRNA” mentioned)
• Static documentation access
  • MKDocs + Nginx
  • SyncThing (mentioned)
• Labeling
  • do lettag label printer (brand referenced)

---

Speakers / sources featured

• Speaker: Brandon Lee (Virtualization HowTo)