Cloudgate documentation

Everything you can do in Cloudgate, how to do it, and where its edges are. Work in the console, hand the job to your AI agent, or script it from the terminal: the same Deployment, three ways in.

Read the quickstart

storefront / production / web

console   press Deploy on web
agent     deploy_service { serviceId: "web" }
terminal  $ cloudgate deploy --env production
 
Deployment queued, building, releasing
running  https://shop.northwind.example

Pick the way you work

Each way in reaches the same Projects, Services and Deployments, under the same roles and the same audit log.

User guideEvery screen of the console, step by step: Servers, cloud accounts, Services, databases, domains, backups, monitoring and your team.In the console MCP and agentsGive an AI agent its own member account, role and key, connect it to the MCP endpoint, and see every tool it can call.From your agent CLIInstall the cloudgate command, log in, deploy a folder, follow logs, set variables, and run it in CI.From your terminal

What people come here to do

The tasks asked about most, each a short page with the steps and a screenshot of the console.

Reference and background

Exact names, parameters and limits, for when you are writing a script, a CI job or an agent's instructions.

REST API17 groups of endpoints, generated from the instance's OpenAPI document.CLI commandsEvery command, flag, variable and exit code.MCP toolsEvery tool an agent can call, its parameters and its budget.How Cloudgate fits togetherOrganization, Project, Environment, Service, Server, Deployment.GlossaryThe words Cloudgate uses, and what each one means.What Cloudgate can and cannot doLimits, gates and what each role may do.

Stuck, or running your own?

If a page here does not answer it, email support@octabyte.io.

Troubleshooting: Builds that fail, Servers that will not set up, domains without certificates.
Questions people ask: Short answers about plans, data, agents and self-hosting.
Self-host Cloudgate: Clone the public repository and install it on your own Ubuntu server, free under the Elastic License 2.0.
Report a bug: Open an issue on GitHub. Report a security problem privately from the repository's Security tab.

Questions about these docs

Where do I start with Cloudgate?

Start with the quickstart: sign up, get a Server (buy one or connect your own with one command), and press Deploy. The user guide then covers every screen of the console.

Can I use Cloudgate without the console?

Yes. The CLI deploys a folder from your terminal or CI, AI agents work through the MCP endpoint, and scripts can call the REST API with a Personal key.

Do these docs cover self-hosted Cloudgate?

Yes. The console, CLI, MCP endpoint and API are the same on the hosted instance and on your own install; pages mark what is hosted only (billing, bought Servers) or self-hosted only (instance settings, the license).

Where is the Cloudgate source code?

In the public repository octabyte-io/cloudgate on GitHub, source-available under the Elastic License 2.0. Its changelog says what each release changes; Install Cloudgate takes you from a clone to a running instance.

Try it while you read

Every plan starts with a 30-day free trial. Bring a server, buy one from us, or connect AWS or Google Cloud.

Start free trial Deploy a template