Deploying your app
Deploying is a few clicks in the dashboard, or a single POST /apps request. Either way, you
provide a name, a container image, a size, and (optionally) ports, environment variables,
volumes, and labels.
From the dashboard
Section titled “From the dashboard”- Open Apps → Deploy App.
- Details — name your app (lowercase letters, numbers, and hyphens) and pick an image. You
can type any image (
nginx,node:20,python:3.12,ghcr.io/owner/repo:tag, …) or choose a ready-made Store template. - Resources — choose a size (from
g3.smallup tog7.2xlarge) and how many instances to run. - Advanced — optional: command arguments, environment variables, volumes, labels, private registry credentials, “sleep when idle”, and “run once”.
- Click Deploy App.
A public URL is assigned automatically once the app is healthy. See the full walkthrough in Apps.
From the REST API
Section titled “From the REST API”curl -X POST https://api.cumin.dev/apps \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "project_id": "…", "name": "my-api", "image": "docker.io/nginx:latest", "ports": [{ "name": "web", "number": 80 }], "env": [{ "name": "NODE_ENV", "value": "production" }], "cpu": 256, "memory": 512, "instances": 1, "hibernated": false }'# { "id": "…" }The Apps API reference documents every field.
What you choose at deploy time
Section titled “What you choose at deploy time”| Setting | Meaning | Example |
|---|---|---|
| Name | Friendly name — lowercase letters, numbers, hyphens | my-api |
| Image | Container image to run | docker.io/nginx:latest |
| Size | CPU and memory (cpu millicores + memory MB) |
g3.small (free) |
| Instances | How many replicas to run | 1 |
| Ports | Ports the container exposes | [{ "name": "web", "number": 80 }] |
| Env vars | Runtime environment variables | NODE_ENV=production |
| Volumes | Persistent mounts | [{ "volume_id": "…", "path": "/data" }] |
Ports and public URL
Section titled “Ports and public URL”Each exposed port gets an auto-assigned public hostname of the form
https://{name}-{port}-{hash}.hosted.ghaymah.systems. Attach a
custom domain when you’re ready for production.
Re-deploying
Section titled “Re-deploying”To update an app, edit its configuration and push the changes — see Configuration. There’s no separate “build” step for image-based deploys: changing the image (or any field) and updating the app is the deploy.
Next steps
Section titled “Next steps”- Configuration — change settings without a full redeploy
- Environment variables
- Resource tiers — sizes and their CPU/memory
- Apps API reference — every field and endpoint