From d961a3e21e399d1d6751d9bb50c6f456471412d5 Mon Sep 17 00:00:00 2001 From: "Jorge O. Castro" Date: Wed, 26 Apr 2023 22:11:52 -0400 Subject: [PATCH] docs: add a better description --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 190ed78..18c59f0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,22 @@ # forge -Self-hosted OS builds +On-premises Universal Blue -This repo is intended to provide the service units necessary to set up a self-hosted OS forge for custom images +This repo is intended to provide the service units necessary to set up a self-hosted OS forge for custom images. + +Imagine something like a home lab or a university lab: + +1. Deploy forge +2. Go into the webui, clone in your favorite uBlue repo and make changes +3. Forge automatically starts to build and images +4. PXE boot the clients, select ublue in the menu +5. Eat tacos +6. Return to a fully deployed lab with centralized package management + +### Components + +We need: + +- webui git frontend to replicate "self hosted ublue" +- a registry +- a certificate authority +- wireguard configs for all of it so people can self host their own personal mirror