aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rwxr-xr-xREADME.md37
1 files changed, 22 insertions, 15 deletions
diff --git a/README.md b/README.md
index 9a90c23..8492c10 100755
--- a/README.md
+++ b/README.md
@@ -5,26 +5,33 @@ migrate most things there.
Welcome to my home-lab!
-This is my personal project to setup all my `r/self-hosted` services
-in my home-lab.
+This is my personal project to setup all my `r/self-hosted` services in my home-lab.
The goal of this repo is to be able to survive a dooms-day scenario where all
-of my hosts die, and I can use to use this repo to be able to re-create it all
-automatically.
+of my hosts die, and I can use to use this repo to be able to re-create it all with *ease*.
+
+The flow is simple. First provision a VM with `tofu`.
+Then deploy the configuration with `nix`.
+
+This is a monorepo with the following structure:
+```tree
+# Definitions for my Proxmox VMs, and LXC (legacy)
+├── terraform/
+# Configurations for my services
+├── nix/
+# Configurations for my services (legacy)
+├── ansible/
+...
+```
+
+# Architecture
+
+tbd
-I use Proxox VE for my hypervisor host to provision my NixOS VMs.
-Then I use Nix to configure them.
# What is NOT covered in this repo?
-* The NAS. I already covered this [here](https://gitlab.com/kdam0/vps#nas-setup).
+
+* The NAS. I already covered this [here](https://git.kumardamani.net/vps#nas-setup).
* The Proxmox install itself, along with networking config of my lab. VPN, VLANs etc.
I go over this in my [blog](https://kumardamani.net/post/framework-server.html).
For now, its all manual.
-
-# What IS covered in this repo?
-* Creating the container/VM infrastructure with [Terraform](https://www.terraform.io/).
-Refer to `terraform/`.
-* OS config, and the application services I self-host with [Nix](https://nixos.org/).
-Refer to `nix/`.
-* OUTDATED! Setting up the application services I self-host with [Ansible](https://www.ansible.com/).
-Refer to `ansible/`.