Documentation

Gheima documentation

Guides for deploying and running services on Gheima, from your first push to scaling, databases, domains and the API.

Start with the basics

Get started

Getting startedYour first deployment, from sign-in to a live URL.

Deploy with an AI agentExact commands for a coding agent, from nothing to a live URL.

Deploy

Deploying appsConnect a repo, set build & start commands, deploy on push.

TemplatesOne-click deploy of popular apps.

Environment variablesAdd encrypted variables and connect a database.

Env groupsShared variables: one group, attached to many services.

DeploymentsLogs, rollback, and deploy hooks.

Error codesEvery GH- failure code explained.

Preview environmentsA live URL for every pull request.

Static sitesStatic builds served by nginx, with routing rules.

Data

DatabasesPostgres, Redis, MySQL and MongoDB, with a query console.

Object storageS3-compatible buckets, keys, and an object browser.

Persistent volumesDurable disks for services. Data survives restarts and redeploys.

Managed searchMeilisearch with a scoped, per-instance API key.

Job queuesBullMQ-ready Redis for background jobs.

EmailSend from your own verified domain.

Operate

Custom domainsAdd a domain with automatic TLS.

ScalingReplicas, autoscaling, and scale-to-zero.

Cron jobsScheduled commands with run history.

MonitoringMetrics, alerts, channels, and log drains.

WebhooksOutgoing event webhooks with signed payloads.

Account

Team & rolesInvite members and manage roles.

Account securityTwo-factor auth, sessions, and API keys.

SSOSign in through your own identity provider.

Billing & plansPlans, limits, and payment in MAD.

Developer

CLIDeploy and manage from your terminal.

REST APIManage resources over HTTP.

SDKTyped TypeScript client.

AI assistantsMCP server, Markdown docs, AGENTS.md.

Schools

For schools and bootcampsCohorts, students, and graduation.