Skip to content

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.

  1. Open Apps → Deploy App.
  2. 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.
  3. Resources — choose a size (from g3.small up to g7.2xlarge) and how many instances to run.
  4. Advanced — optional: command arguments, environment variables, volumes, labels, private registry credentials, “sleep when idle”, and “run once”.
  5. Click Deploy App.

A public URL is assigned automatically once the app is healthy. See the full walkthrough in Apps.

Terminal window
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.

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" }]

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.

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.