Documentation

Everything you need to run Roost and build apps for it.

Running Roost

Install Roost on your hardware and set up your personal cloud. Covers Mac, Linux, and Raspberry Pi.

  • Installation (Mac, Linux, Raspberry Pi)
  • First run & setup
  • Installing apps
  • DNS & ad blocking
  • Remote access
  • Backups & updates

Building Apps

Build full-stack TypeScript apps with Cameo. Database, real-time events, and type-safe APIs included.

  • Quickstart & app structure
  • Schema & type generation (Cameo)
  • Server API (database, events, uploads)
  • Client API (RPC, real-time)
  • Packaging & publishing

Architecture

Technical deep dive into how Roost works. App runtime, gateway infrastructure, database design, and native clients.

  • Traffic flow & gateway
  • V8 isolate app runtime
  • Platform services & media
  • SQLite database design
  • Push notifications (E2E encrypted)
  • iOS & desktop native clients