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.
Docker Compose
Prebuilt images, one docker compose up -d. Recommended for almost everyone - a few minutes and it's live.
Bare metal
No Docker: an install script builds ravyn from source, sets up Postgres and systemd, and configures Caddy for TLS.
Features
Everything ravyn does, one page: 2FA, quotas, chunked uploads, webhooks, and the rest.
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.