Get started

Choose how you want to run Masir, then publish a working link.

Masir is a Bun application with a Postgres database. The deployment method changes how you start it. It does not change the product.

Choose an install path

Published image

Recommended for production. Pull a release image and run it with the included Postgres stack.

Build the image

Use this when you maintain a fork or need a change that is not in a release.

Run from source

Use this for local development or a host where you manage Bun and Postgres.

All paths need Postgres 18 or newer. Production also needs a domain and HTTPS.

The shortest path

On a Linux server, the installer creates a masir directory, downloads the published Compose stack, generates secrets, and starts Masir.

curl -fsSL https://raw.githubusercontent.com/hamedniroomand/masir/main/scripts/install.sh | sh

The script asks for the public origin, such as https://go.example.com.

What success looks like

After installation:

1. GET /api/health reports that the app and database are ready.
2. The seed command creates the first owner account and workspace.
3. You can sign in and create a short link.
4. Opening the short URL returns a 302 to its destination.

Continue

Install Masir

Configure a production stack and verify it.

Create your first link

Learn the main workflow after the server is ready.