Quick start
This guide takes you from a fresh account to a deployed, public app in three steps. Pick either the dashboard or the REST API.
Dashboard
Section titled “Dashboard”1. Sign in
Section titled “1. Sign in”Open deploy.ghaymah.systems and sign in (or click Create an account).
2. Deploy an app
Section titled “2. Deploy an app”Open Apps → Deploy App, then:
- Details — name your app (lowercase letters, numbers, hyphens) and pick an image
(e.g.
nginx). - Resources — choose a size (
g3.smallis free) and instance count. - Advanced — leave empty to accept defaults.
3. Open your URL
Section titled “3. Open your URL”Ghaymah provisions the app and assigns a public URL automatically:
https://my-app-web-7f3a9c.hosted.ghaymah.systemsThat’s it. Your app is live.
REST API
Section titled “REST API”1. Create a project & token
Section titled “1. Create a project & token”curl -X POST https://api.cumin.dev/projects \ -H "Authorization: Bearer $ADMIN_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "my-project" }'# { "id": "…", "token": "…" }2. Deploy an app
Section titled “2. Deploy an app”curl -X POST https://api.cumin.dev/apps \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "project_id": "…", "name": "my-app", "image": "docker.io/nginx:latest", "ports": [{ "name": "web", "number": 80 }], "cpu": 256, "memory": 512, "instances": 1, "hibernated": false }'# { "id": "…" }3. Find your URL
Section titled “3. Find your URL”curl https://api.cumin.dev/apps \ -H "Authorization: Bearer $TOKEN"The app’s ports[].hostname holds its public URL, assigned automatically.
What just happened
Section titled “What just happened”- An app (a container) was created inside a project.
- It’s reachable at a public URL immediately, and its logs stream from the dashboard or
GET /logs/{id}.
Next steps
Section titled “Next steps”- Customize your deployment — names, ports, sizes, domains
- Set environment variables
- Stream logs
- Attach a custom domain