Skip to content

v1.5.0 — User manual on the landing portal

Choose a tag to compare

View all tags
@bogdandragosvasile bogdandragosvasile released this 20 Apr 11:09
· 8 commits to main since this release
v1.5.0
5fdc760

Highlights

After bootstrap, the landing portal now links to a full user manual served alongside portal.local — no GitHub round-trip needed.

What's new

Added

  • http://portal.local/manual.html — a self-contained 16-section user manual styled to match the portal's dark/light theme. Includes a sticky TOC sidebar with scroll-spy active highlighting, monospace code blocks, callout boxes, and tables. Sections:
    • Overview — what the platform is, shortest path for new users
    • Prerequisites — per-OS tables (Linux / WSL2, macOS + Colima sizing tip, Windows 11)
    • Quick start — one-command bootstrap for every host, zero .env edits
    • Architecture — diagram of the docker network + k3d cluster
    • Bootstrap phases — the full 16-phase table with what each script does
    • Service URLs & credentials — canonical reference + one-liner to dump .env
    • Vaultwarden import — web-UI walkthrough + bw CLI commands
    • Single sign-on (Keycloak) — test user, login flow, adding users
    • Deploy your own application — short-form recipe (with link to docs/ADD_YOUR_APP.md)
    • Lifecycle — restart, teardown, backup & restore
    • Observability — Grafana dashboards, Prometheus retention, Loki LogQL
    • Security — NetworkPolicies, pre-commit hooks, Sealed Secrets
    • AI agent federation — agent matrix + skill list
    • Platform-specific notes — Colima DNS patch, inotify tuning, .local mDNS, MSYS path translation
    • Troubleshooting — six common issues with copy-paste fixes
    • Extending further — domain agents, Grafana dashboards, webhooks, pre-commit hooks in multiple repos
  • Documentation card on the portal home page linking to the manual.

Changed

  • gitops-repo/manifests/portal/src/Dockerfile copies manual.html into the nginx document root.

Upgrading existing clusters

After pulling v1.5.0:

git pull
bash scripts/07-push-gitops-repo.sh    # pushes new Dockerfile + assets to Gitea
bash scripts/09b-build-portal.sh        # rebuilds portal image + imports into k3d
kubectl -n portal rollout restart deploy portal

Then open http://portal.local — the new Documentation section with the User Manual card will appear.

Full changelog

See CHANGELOG.md.

Assets 2
Loading