Skip to content

trentnbauer/xfgn-docs

Repository files navigation

🗂 What is this?

Welcome, friends

Welcome to the XFGN / AGG / LM internal documentation site.

If you're looking for out guides, please click here, otherwise get reading!

Isn't this overkill?

Yeah - definitely. Why am I doing it? Great question!

I want my Homelab to be well documented for 2 reasons, the main being the Bus Factor. I also enjoy sharing this hobby with others and having things written and drawn allows me to do so while reducing the risk of an inexperienced person breaking something permanently.

This documentation is intended for internal use though I have made it public as there are tid-bits of useful information for others to use in their homelabs.

A few to note;

Common acronyms and words

NameMeaning
ComputeCPU or RAM requirement and/or usage
HomelabA server or server-like environment physically located in a persons home, used for hobby, testing or educational purposes
ContainerA Docker container (which has all the files and folders required to run an app and is OS agnostic)
Hypervisor Virtual machine OS / software. Eg proxmox, ESXi, Hyper V etc.

GitBook management and styling

  • Any pages with a question mark icon are incomplete or outdated

Credentials

  • When Bitwarden is referenced, 99% of the time it is the Bitwarden organization 'XFGN/aGG'
  • All internal and external credentials are saved in the Bitwarden organization
  • My Bitwarden account is secured behind 2 FIDO keys
    • One on my keychain
    • The other is stored inside Macaroni
  • I have enabled 'emergency takeover' on my vault, with the below people having access
    • Mia W

\

About

Internal Documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published