Getting started

ravyn is three services: an API, a web frontend, and Postgres. Pick the install path that fits how you already run this server.

What you'll end up with

Both paths get you the same three pieces:

  • ravyn-api - the Rust/Axum backend: auth, storage, everything that touches the database.
  • ravyn-web - the Leptos frontend the browser actually talks to.
  • Postgres - one small database for accounts, file records, and settings. The files themselves live on local disk or S3, not in Postgres.

After it's running

The first account you register becomes the instance's admin automatically - there's no separate setup wizard. From /admin that account can open or close registration for everyone else, set storage quotas, and configure everything else covered on the features page.