ZoCloud User Guide
English · Tiếng Việt
ZoCloud builds and runs your app from GitHub, from a folder on your machine or from a Docker image, with databases, object storage, domains, business e-mail, an AI gateway and payment through a VND wallet. The servers and the primary backups are in Vietnam.
- Portal:
https://app.zocloud.io - API:
https://api.zocloud.io/v1 - System status page:
https://app.zocloud.io/status
Table of contents
| Document | Contents |
|---|---|
| Apps: projects, services and deployments | Projects, environments, services (web, worker, cron, private), deploy sources, zocloud.json, environment variables, private networking, volumes, scaling, sleep mode, previews, logs, rollback, custom domains, security |
| Databases | PostgreSQL, MySQL (MariaDB), Redis (Valkey): connecting, access from the Internet, backup and restore, browsing data |
| Object storage (S3) | Object storage (S3) on s3.zocloud.app |
| Domains | Buying, renewing and transferring domains, .vn paperwork, ZoCloud DNS, connecting Cloudflare |
| Business e-mail (Google Workspace, Microsoft 365) | Google Workspace and Microsoft 365 |
| AI gateway | OpenAI-compatible AI gateway |
| Billing | Wallet, top-ups, plans, usage-based billing, statements, VAT invoices |
| Organisations, members and account security | Organisations, members and roles, 2FA, tokens, activity, notifications, support |
| zo CLI and MCP server | zo CLI, MCP server for AI agents, connecting ChatGPT |
Sections of the portal
After signing in and choosing an organisation, the navigation bar has: Projects, Domains, E-mail, AI, Billing, Members, GitHub, Notifications, Activity, Support. The account menu (top right) has Account, Billing, Light/dark, Sign out.
Press Ctrl+K (macOS: ⌘K) to open the Command palette: find a project, service, database or action.
On a service, project or organisation page you will sometimes see a suggestion from ZoCloud (for example a volume that is nearly full, or a recommendation to turn the firewall on). You can Dismiss it or choose Remind me later.
Ask ZoCloud
The Ask ZoCloud button sits at the bottom right of every page. ZoCloud looks at your organisation's apps, logs, domains, databases and billing to answer right away. You can also click Ask ZoCloud on a failed deployment or on a domain that does not work yet, to ask about exactly that.
- When a setting needs to change (a port, a new deployment…), ZoCloud only proposes it. Nothing changes until you click Agree, and only for roles allowed to deploy.
- The number of questions a day depends on your plan (shown under the chat).
- Hand to the team opens a ticket with the whole conversation.
Quick start (5 minutes)
1. Create an account
- Open
https://app.zocloud.io/signup. - Fill in Name, E-mail, Password (at least 10 characters) and click Sign up. If ZoCloud has Google sign-in turned on, you can click Continue with Google instead.
- ZoCloud creates a personal organisation for you automatically.
2. Verify your e-mail and finish setting up
- Open your inbox and click the verification link. If the message does not arrive, click Send again on the banner "Please verify … with the link in your inbox".
- The portal shows a Finish setting up your account box. Besides Verify your e-mail address, you do one of two things:
- Top up: put a small minimum amount into your wallet (the money stays yours, to spend on services), or
- Connect GitHub: connect a GitHub account that is at least the required number of days old.
- Once that is done, the organisation is ready to use. In some cases the ZoCloud team reviews the account by hand ("Our team reviews new accounts…"); you will get an e-mail when it is ready. Until then you cannot deploy or create databases.
3. Create a project
- In Projects, click New project.
- Enter a Project name (lower-case letters, digits and
-), choose a Location (where the apps and databases run) and click Create. - You land on the project's canvas; the default environment is
production.
4. Deploy an app
Click New on the canvas and choose one of the ways in:
From a GitHub repository (opens the Deploy from Git dialog), which has three tabs:
| Tab | When to use it |
|---|---|
| GitHub | A public or private repository through ZoCloud's GitHub App. You need to Connect GitHub first (see Apps: projects, services and deployments). Pushing to the branch deploys automatically. |
| Public Git URL | A public repository over https://… |
| Docker image | A public image on Docker Hub, GHCR, Quay…, for example wordpress:6 or ghcr.io/owner/app:1.0 |
Choose the repository (or paste the URL / image name), check the Service name, Branch, Root folder and Start command (leave it empty to let ZoCloud choose), then click Create and deploy.
From your machine (zo CLI): push a folder up, no Git needed.
curl -fsSL https://app.zocloud.io/install.sh | sh
zo login # paste a token created at Account → Access tokens
zo deploy -to <organisation>/<project>/web # run inside the app's folder
From a template: WordPress, n8n, Ghost, Uptime Kuma… come with their database, storage and environment variables already configured. Pick a template and click Deploy the template.
ZoCloud detects the framework, builds and runs the app. Follow the progress on the service's Deployments tab.
5. Open the app
Every web service comes with an HTTPS address of the form:
https://<service>-<project>.zocloud.app
The address is shown right under the service's name (and printed at the end of zo deploy). If that name is already taken, ZoCloud adds a short suffix.
Important: the app must listen on 0.0.0.0 and on the port in the PORT variable. The most common deployment failure is an app that only listens on localhost or on some other fixed port.
Next steps
- Add a database: Databases
- Attach a custom domain: Apps: projects, services and deployments
- Let an AI agent deploy for you: zo CLI and MCP server