THE GUIDEBOOK TO YOUR NEW HOME

Let’s get you settled in.

From your first install to the backup you hope you never need. Practical guides for running your own Roost community.

NEW HERE?

Start with the big picture.

Choose a deployment path, check the prerequisites, and make your first admin account.

YOUR TERMINAL

git clone https://github.com/msrbuilds/roost.git
cd roost
bash install.sh

Node.js 22+ · Docker for VPS deployments

Choose your stack, install Roost, and create your first admin.

Walk through configuration with the included setup script.

Run the frontend and API with automatic HTTPS.

Self-host Roost, Supabase, and private file storage together.

Use managed Postgres and authentication.

Keep the database and authentication on your own infrastructure.

Deliver confirmations and password resets through Brevo.

Keep a private offsite copy and verify it can be restored.

Verify permissions, email, realtime, and backup recovery.

Diagnose installation and service startup failures.

Deploy the frontend separately from the backend.

Publish the static frontend with a separately hosted API.

Find the right VPS deployment guide.

Found something we can make clearer?