From 877f05324cee226d0b6e40fad0d82d03845fd3aa Mon Sep 17 00:00:00 2001 From: Daniel Maksymilian Syrnicki Date: Fri, 6 Mar 2026 10:53:10 +0100 Subject: [PATCH] Improve README: principles, architecture detail, actual progress, business model MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Reflects actual project state from Robert/Daniel discussions — Arch already running on Proxmox, webapp prototype working, and long-term Proxmox-style business model. Co-Authored-By: Claude Opus 4.6 --- README.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ba0fb92..207b9d3 100644 --- a/README.md +++ b/README.md @@ -16,17 +16,26 @@ Homebase aims to be: - **Built for normal people** — your dad should be able to run his own cloud server - **Fully open source** — with an optional support/infrastructure subscription (Proxmox model) +## Principles + +- **Everything already exists** — We're not inventing, we're connecting. Docker, reverse proxies, Let's Encrypt — it all works. We just wire it together with default configs and a simple wrapper. +- **Dogfooding** — We build what we use ourselves. If we wouldn't run it at home, we don't ship it. +- **Two-tier UX** — Dead simple for beginners (click Install, done), full control for advanced users (SSH in, edit configs, do whatever you want). + ## Architecture ``` +------------------+ | Web UI | <- Simple admin panel / app store +------------------+ -| Service Layer | <- Docker compose orchestration, default configs +| Settings | <- UI/API wrapper that generates Docker configs +| Wrapper | from simple user choices ++------------------+ +| Docker | <- Containers with sensible default configs +------------------+ | Gateway | <- Reverse proxy, SSL, DNS (self-hosted or managed) +------------------+ -| Base OS | <- Minimal Linux (Arch or Debian TBD) +| Base OS | <- Minimal Linux (leaning Arch, Debian as fallback) +------------------+ | Any x86 HW | <- Old PC, mini PC, NUC, whatever +------------------+ @@ -36,9 +45,9 @@ Homebase aims to be: | Decision | Status | Notes | |----------|--------|-------| -| Base OS | TBD | Arch (more control, CachyOS-style) vs Debian (Proxmox ecosystem, FAI for images) | +| Base OS | Leaning Arch | Robert already has Arch running on Proxmox and is building custom images. Debian remains fallback (FAI, Proxmox ecosystem). | | Containers | Docker | Lower overhead than VMs, easier default configs | -| Installation | Web-based wizard | Robert has a webapp prototype that reads devices and saves form data to JSON | +| Installation | Web-based wizard | Robert's webapp prototype (device reader + form → JSON) is working | | Gateway | Flexible | Own reverse proxy OR managed through our infrastructure | | UI approach | UI-first | Design the simplest possible UI, then build everything to match | @@ -51,12 +60,21 @@ Homebase aims to be: ## Roadmap +- [x] Installer webapp prototype — device reader + form → JSON (Robert) +- [x] Arch running on Proxmox, custom image builds in progress (Robert) - [ ] UI mockups / drafts (Robert) -- [ ] Base OS decision (Arch vs Debian) -- [ ] Installer prototype (web-based wizard) +- [ ] Base OS finalized (Arch vs Debian) - [ ] First containerized service (Nextcloud?) - [ ] Gateway / reverse proxy setup -- [ ] Custom OS image build pipeline +- [ ] Settings wrapper — generate Docker configs from user choices + +## Business Model + +Homebase starts as a private/personal project. The long-term model follows Proxmox: + +- **Free & open source** — anyone can download, install, and use it +- **Paid support & managed infrastructure** — for users who want hassle-free setup +- **Managed gateway option** — the gateway (reverse proxy, SSL, DNS) can be self-hosted or run through our managed infrastructure (potential subscription revenue) ## Team