Cloady Docs

Getting Started

From an empty account to a live app on an HTTPS URL.

The file content below is exactly what I verified at /private/tmp/claude-501/-Users-xercool-Documents-Projects-cloady/044ba003-68d7-413e-a65f-e0075f86c1fc/scratchpad/final.mdx (SVG line diffed byte-identical against the original).

Getting Started

From an empty account to a live app on an HTTPS URL: sign in, create a workspace, pick where the app runs, deploy, point your own domain at it, then script the rest.

Core Concepts defines the model; the Dashboard Guide tours the controls you'll click.

1. Sign in

Go to cloady.com and sign in with a one-time code mailed to you, Google, GitHub, or your company's SSO. There are no passwords; the first sign-in creates your account. You can also start from the deploy field on cloady.com before signing in: configure the app there, and Deploy asks you to sign in without leaving the page, then deploys it.

First sign-in creates your account and asks you to verify a phone number: enter it, then the code you receive by SMS. It's required once per account — until it's done the dashboard sends you back to that screen and the API answers phone_required (403). Then you land on an empty dashboard.

2. Create a workspace

A workspace holds your applications, your team and one subscription, at its own address cloady.com/w/acme-inc. Click New workspace:

  1. Name — e.g. Acme Inc. The name used in URLs is derived from it and shown live; if that one is taken you'll see the adjusted version.
  2. Icon · optional — click the tile in the modal header to upload one. It also sets the workspace's colors. A new workspace costs nothing and can deploy right away. What it pays follows what its apps declare, priced on four plans — see Capacity and price — and every workspace whose apps fit inside 0.5 vCPU, 1 GB of RAM and 5 GB of SSD pays nothing.

One subscription covers every region — there is nothing to switch on per region.

3. Pick a region and environment

Every app runs in exactly one region and one environment, both chosen when you deploy it. You set them in the top bar; a new app starts with what's selected there, and its card lets you pick another region before you deploy.

  • Region — the city your app runs in. The menu lists Deployed regions (ones you already have apps in) and Available ones; switching also filters the dashboard. A region is fixed for the life of an app — to run the same app in a second region, deploy it there too.
  • Environment — Production, Preview or Development. An application's name is unique within a workspace and environment, so api can exist in production and in preview at once. Development apps keep an editable copy of your code and don't redeploy on push.

One thing you may run into:

  • If a region has no spare capacity the app shows waiting for capacity while a machine is added, then carries on by itself — usually a few minutes. If it still can't be placed after about 40 minutes the deploy fails; retry it.

4. Deploy an app

Three sources converge on one Launch click, after which Cloady fetches, builds, runs and routes the app and returns a live HTTPS URLYOUCLOADYDrop a folderGitHub repoCatalog appConfigure & launchname · region · env varsLaunch — the rest is automaticFetch sourcerepo, upload, orcatalog templateBuild imagecode sources onlycatalog: prebuiltStart containersin the regionyou pickedRoute + TLSHTTPS andDNS, no configYour app is livepublic HTTPS URL, no setup

Click New application in the top bar and tell the field what to deploy:

  • A template — a pre-built application (WordPress, Postgres, …); type to search and click one.
  • A GitHub repository — paste its URL or pick one of your repos. Public repos work straight away; for a private one choose Connect GitHub account first.
  • A Docker image — type its name (nginx, ghcr.io/acme/api:1.4), or a registry such as docker.io/ to browse popular images.
  • A folder — drag it in, up to 50 MB and 3000 files (node_modules, .git, .next, __pycache__ and .DS_Store are skipped). Good for a built static site — no git needed.

The field turns into the app's card. Edit the name at the top (the address next to it follows), check the price beside it, and open any row under Settings to change it before you deploy:

  • Environment — fill in variables; templates list the ones they need and can generate passwords for you.
  • Build — for code: the branch, the root directory, and optional build and start commands. Leave those blank unless detection guesses wrong, which happens on monorepos and on builds that live in a subfolder. Redeploy on every push is on by default for GitHub sources.
  • Resources, Region, Domain and Managed backups — scale factors, where it runs, a custom domain to attach, and daily backups.

Press Enter or click Deploy. Inside the free allowance nothing is charged. Beyond it, the card on file is charged for the rest of the month; with no card, or a declined one, the deploy returns payment_required (402) and nothing is created.

Cloady builds the app, sets up HTTPS for you, and serves it at a cloady.io address built from the app name, a short unique code and the workspace name:

<app-name>-<code>-<workspace>.cloady.io

So an app named My Blog in workspace acme is reachable at:

my-blog-k7q2v9ze-acme.cloady.io

Every environment and every region uses the same form; the exact URL is on the app's page.

The app appears on the workspace grid while the modal streams the deploy. Configuration and any generated secrets live under Settings → Environment.

Renaming an app

Rename it in Settings → General. The address follows the name, so the old hostname stops answering and the new one starts — update any links, DNS records and API calls that used it. (The Slug field is the part that appears in the URL; set it yourself and it stops following the name.)

Never delete an app to rename it. Deleting an app destroys its data permanently — every service, volume, environment variable, domain and deploy record, with no undo. The dialog makes you type the app's name to confirm.

5. Add a custom domain

To serve the app on your own hostname, open Settings → Domains.

  1. Enter the hostname (e.g. app.yourdomain.com) and click Add domain. Tick Redirect to another host (308) if it should forward somewhere else instead of serving the app.
  2. Point DNS at Cloady with the DNS configuration panel, which shows the exact records to copy:
    • CNAME (default) — one record pointing at the app's built-in cloady.io hostname. Best for subdomains.
    • A / AAAA — for the apex (root) domain, which can't be a CNAME. Add both records exactly as shown.
  3. Once DNS resolves, Cloady sets up HTTPS for the host by itself. The domain row tracks it: queued → pending → issued (TLS · active). failed (TLS · error) almost always means DNS isn't pointing at Cloady yet — fix the record and it retries.

The built-in cloady.io hostname keeps working alongside your domain. You can also attach a domain while deploying, from the card's Domain row; Check DNS there tells you whether the records already point at Cloady.

6. Automate with the CLI, API, Terraform or MCP

Everything in the dashboard is scriptable.

  • CLI — npm install -g cloady, cloady login, then cloady deploy github.com/your-org/your-repo. See the CLI Reference.
  • REST API — create workspaces, deploy apps, manage domains and stream logs with personal API tokens. See the API Overview and the endpoint reference.
  • Terraform — declare workspaces, applications, environment variables and domains as code, then terraform apply. See the Terraform Provider guide.
  • MCP server — drive Cloady from an AI agent, with the same operations as tools. See the MCP Server guide.

Next steps

  • Core Concepts — workspaces, applications, regions, environments, domains and the subscribed pool.
  • Dashboard Guide — every panel and control, in detail.

On this page