Daniel Maksymilian Syrnicki 7759574481 docs: add changelog, contributor guide, release process, and runner setup

- CHANGELOG.md: Keep-a-Changelog format, [26.0-alpha] entry covering
  everything shipped so far (installer webapp, drive scoring, base
  archinstall config, wireframes, competitor analysis, wizard flow spec)
- CONTRIBUTING.md: dev setup, conventional commit format, code style
- RELEASING.md: calendar versioning rules (YY.N-stage, no "v" prefix)
  and the release workflow (bump changelog, commit, tag, push, create
  Forgejo Release)
- docs/runner-setup.md: install + register a forgejo-runner so the
  upcoming CI workflow actually executes

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

2026-04-13 20:23:48 +02:00

2.4 KiB

Raw Permalink Blame History

Changelog

All notable changes to Homebase will be documented in this file.

The format is based on Keep a Changelog. This project uses calendar versioning: YY.N-stage (e.g. 26.0-alpha = 2026, release 0, alpha stage).

Unreleased

26.0-alpha - 2026-04-13

First tagged snapshot. Pre-alpha — the installer does not yet boot, but the design is locked and the prototype components are shaped.

Added

Installer webapp prototype (webinstaller/) — Flask app with 3-step wizard (hostname → drive → overview), serves drive list via drives.py::list_scored_devices().
Drive scoring module (webinstaller/drives.py) — scores attached disks by type (NVMe/SSD/HDD), SMART health (smartctl -H), and size. Consumed by the installer and usable as a CLI.
Base archinstall configuration (archinstall/user_configuration.json) — systemd-boot, ext4, Docker + Compose preinstalled, server profile, SSH. Credentials template at archinstall/user_credentials.example.json (real credentials gitignored).
Installer wireframes (docs/installer-wireframes.md) — Robert's hand-drawn 4-screen UX sketches.
Competitor analysis (docs/competitors.md) — CasaOS, Umbrel, YunoHost reviewed across install flow, hardware detection, app store UX, reverse proxy/SSL, user complaints. Key finding: device-aware wizard + managed gateway are uncontested differentiators.
Wizard flow spec (docs/wizard-flow.md) — 8-screen first-boot flow extending Robert's wireframe with YunoHost-style domain/SSL/diagnostic/confirm screens. Locked tech picks with rejected alternatives.
Project README — vision, principles, architecture, key decisions, landscape, roadmap.

Decisions locked

Reverse proxy: Caddy (auto Let's Encrypt, simplest config)
Identity provider: Authentik (bundled SSO, every app auto-wired at install)
Managed gateway DNS: NS delegation to ns1.homebase.cloud / ns2.homebase.cloud (wildcard cert via Let's Encrypt DNS-01)
Local HTTPS: Local CA installed by user once (no browser warnings on *.proksi.local)
Base OS: Arch (rolling, Debian remains fallback)
Containers: Docker + Compose
License: AGPL-3.0