Documentation · Dokumentation

The rumahl documentation

Installation, architecture, API reference, security model and app development — written in Markdown, available in English and German.

Ctrl K

Featured documentation

The core documentation — everything you need to run, understand and extend rumahl.

Install rumahl OS on any platform — system requirements, flashing images, Docker Compose and development mode.

Get rumahl running in under five minutes — clone, start, create your admin account and explore the dashboard.

How rumahl OS is built — Rust microservices, ports, the platform principle and the security layers.

The rumahl REST API — base URLs, authentication, endpoint groups and the permission model.

Defense in depth — how rumahl protects your home: authentication, network security, encryption, threat detection and platform hardening.

Build apps and plugins for rumahl — the manifest, Apps vs. Plugins, the ora.* SDK and publishing to the Store.

Every document — sorted by area and category.

Reference knowledge about the system, security and architecture.

Installation & Setup

Security & Permissions

System & Architecture

Guides for building your own apps, plugins and the rumahl Store.

App Development

The support center has friendly guides, a FAQ and direct contact — for the moments you just want a quick answer.

The SDKs page has quickstarts for all six languages — and the app development docs show the full platform surface.