daniel/furtka
1
1
Fork 0
Code Issues 1 Pull requests Projects 1 Releases 13 Packages Wiki Activity Actions

Improve README: principles, architecture detail, actual progress, business model

Browse source 
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 <noreply@anthropic.com>
This commit is contained in:
Daniel Maksymilian Syrnicki 2026-03-06 10:53:10 +01:00
parent c87701f1e5
commit 877f05324c
1 changed files with 25 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -16,17 +16,26 @@ Homebase aims to be:
- **Built for normal people** — your dad should be able to run his own cloud server - **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) - **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 ## Architecture
``` ```
+------------------+ +------------------+
| Web UI | <- Simple admin panel / app store | 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) | 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 | Any x86 HW | <- Old PC, mini PC, NUC, whatever
+------------------+ +------------------+
@ -36,9 +45,9 @@ Homebase aims to be:
| Decision | Status | Notes | | 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 | | 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 | | Gateway | Flexible | Own reverse proxy OR managed through our infrastructure |
| UI approach | UI-first | Design the simplest possible UI, then build everything to match | | UI approach | UI-first | Design the simplest possible UI, then build everything to match |
@ -51,12 +60,21 @@ Homebase aims to be:
## Roadmap ## 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) - [ ] UI mockups / drafts (Robert)
- [ ] Base OS decision (Arch vs Debian) - [ ] Base OS finalized (Arch vs Debian)
- [ ] Installer prototype (web-based wizard)
- [ ] First containerized service (Nextcloud?) - [ ] First containerized service (Nextcloud?)
- [ ] Gateway / reverse proxy setup - [ ] 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 ## Team