diff --git a/README.md b/README.md index eacce17..705f10f 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,16 @@ # home-lab +> DISCLAIMER: +> This is a work in progress documentation. +> Everything is written by hand without using any LLMs to generate the instruction. +> Reasoning is that writing this down helps me process and internalise the information on top of having clean docs to replicate things if they break. + This repo will be used to contain .md files to describe new home lab projects, scripts to run the home lab, general information about the architecture and some more general notes about its philosophy. This repo will eventually be hosted on the home lab itself. +This is a work in progress documentation. +Thing might eventually be moved to a dedicated documentation service like BookStack, NetBox etc. -## Hardware +## Setup overview +### Hardware Currently the home lab is a single desktop PC with the following specs: * CPU: i7-7700k (4 cores @ 4.2GHz) @@ -11,5 +19,25 @@ Currently the home lab is a single desktop PC with the following specs: * Storage: 1x1TB NVMe SSD, 2x1TB HDD * Motherboard: MSI Z270 Arctic Tomahawk -## OS +### OS The OS is Ubuntu Server 26.04.1 LTS. + +### Updates & Maintenance +* `unattended-upgrades` for package maintenance, [more info](/maintenance/unattended_upgrades.md). +* `Dockge` to manage docker stacks, [more info](/docker/notes.md). + +### Monitoring + + +### Networking +* `Tailscale SSH` for remote access, [more info](/networking/SSH-Tailscale.md). +* `cloudflared` + `nginx` for everything ingress related, [more info](/docker/ingress.md). + +### Security +* `CrowdSec` for improved security measures beyond what is provided by Cloudflare, [TODO more info](/security/crowdsec.md). + +### DevOps +* `gitea` to host my repos, [more info](/git%20forge/gitea.md). + +### Storage +* `MergerFS` to pool multiple drives into a single mount point, [more info](/storage/filesystem.md). \ No newline at end of file