The rumahl documentation
Installation, architecture, API reference, security model and app development — written in Markdown, available in English and German.
Featured documentation
The core documentation — everything you need to run, understand and extend rumahl.
Installation
Install rumahl OS on any platform — system requirements, flashing images, Docker Compose and development mode.
Quick Start
Get rumahl running in under five minutes — clone, start, create your admin account and explore the dashboard.
rumahl Developers Portal
The developer portal, organizations, teams, app registration, verification, and phased rollouts in the rumahl ecosystem.
Developer REST API
Complete REST API reference for rumahl Developers: apps, releases, binaries, team members, webhooks, and API keys.
OAuth 2.0 & rumahl Account
Single Sign-On with rumahl Account: OAuth 2.0, OpenID Connect, PKCE flow, scopes, passkeys, and consent management.
SDKs & CI/CD Integration
Automation and code examples using TypeScript & Python SDKs, cURL, and GitHub Actions for releases.
Architecture
How rumahl OS is built — Rust microservices, ports, the platform principle and the security layers.
API Reference
The rumahl REST API — base URLs, authentication, endpoint groups and the permission model.
Security Model
Defense in depth — how rumahl protects your home: authentication, network security, encryption, threat detection and platform hardening.
App Development
Build apps and plugins for rumahl — the manifest, Apps vs. Plugins, the ora.* SDK and publishing to the Store.
All documentation
Every document — sorted by area and category.
Documentation
Reference knowledge about the system, security and architecture.Installation & Setup
Security & Permissions
App Development
Guides for building your own apps, plugins and the rumahl Store.App Development
- App DevelopmentBuild apps and plugins for rumahl — the manifest, Apps vs. Plugins, the ora.* SDK and publishing to the Store.7 min
- Developer REST APIComplete REST API reference for rumahl Developers: apps, releases, binaries, team members, webhooks, and API keys.10 min
- OAuth 2.0 & rumahl AccountSingle Sign-On with rumahl Account: OAuth 2.0, OpenID Connect, PKCE flow, scopes, passkeys, and consent management.9 min
- rumahl Developers PortalThe developer portal, organizations, teams, app registration, verification, and phased rollouts in the rumahl ecosystem.8 min
- SDKs & CI/CD IntegrationAutomation and code examples using TypeScript & Python SDKs, cURL, and GitHub Actions for releases.8 min