Put your first app online
Three ways to a running app, from the quickest to the most hands-on. Pick the tab that matches what you have, a ready-made app, your own code in git, or a folder on your computer.
Applies to: Hosted and self-hostedOwner or Admin
Cloudgate deploys onto a Server (a machine it reaches over SSH) or into your AWS or Google Cloud account. Before your first app runs, you need one of those, a Project with an Environment, and the app itself. Each path below does those three things for you, in a different amount of detail. If the words are new, How it fits together explains the model in two minutes.
What you can do from here
- Deploy an app from the template catalogue with the get-started wizard, including getting a server.
- Deploy your own code from GitHub, GitLab, Bitbucket, Gitea, any git URL or a Docker image in the console.
- Deploy a folder from your computer or a CI job with the CLI.
Deploy your first app
App template (wizard)
The get-started wizard is the shortest path. It starts from an app in the template catalogue, such as Ghost, Umami or n8n, and ends with that app running at an address you can open.
Pick an app and sign in
On the templates website, open an app and press its Deploy button. It opens the console at
/get-startedwith that app chosen. If you are not signed in, sign in or press Create an account; you come back to the wizard afterwards. On the Hosted instance, the link in the confirmation email signs you in and returns you here.The first question is where the app runs. A Ready Server you already have is offered first. Choose where it runs
The wizard asks Where should the app run?
- If your Organization already has a Ready Server, press Use followed by its name, for example Use fra-1.
- Get a server from Cloudgate (Hosted only): pick a location and a size, then Buy. The wizard shows Payment, Creating your server, Setting it up and Ready to use. You can leave the page; it carries on.
- Use my own server: for a machine you already rent, such as a VPS. Fill in Your server
(address, SSH port, SSH user, name). If the Organization has no SSH key yet, press Make a key,
then copy the one-line command the wizard shows and run it on the server. It adds the key to
~/.ssh/authorized_keys. Press Save and continue, then Connect my server. Progress reads Signed in to your server, Installing what apps need, then Ready.
Fill in the details
Answer the values the app asks for. Passwords and keys it needs are made for you. The summary, What Deploy makes, lists the Server, a New Project named after the app, and a web address marked Made for you.
Everything the wizard is about to create is listed before you press Deploy. Deploy and open it
Press Deploy followed by the app’s name. Cloudgate creates the Project with a
productionEnvironment on that Server and, once the Server is ready, applies the setup as you. When it is running, press Open to visit it, or Open the Project to see what was made.
Your own code (console)
Your own code needs four things made by hand, in this order. Each step links to the guide page that covers it in full.
Add a Server
Open Servers and press Add a Server. If you have no SSH key yet, open Manage SSH keys and press Generate one, then put the line it shows in the machine’s
~/.ssh/authorized_keys. Fill in the address, the SSH user (root, or a user with passwordless sudo) and the key, and press Add Server. On the Server’s Infrastructure tab, press Check now, then Run setup. Setup installs Docker, a Swarm and Traefik. See Add a Server.Servers are shared by every Project in the Organization. Make a Project and an Environment
Open Projects, press New Project, name it (for example
storefront) and press Create Project. On its Environments tab press New Environment, call itproduction, choose your Server as the Deploy target, and press Create Environment. See Projects and Environments.Add an Application
In the Environment, on Services, press Add an Application, name it
weband pick the Server. On its Overview, open the Source card and press Change source: pick a connected git provider and a repository and branch, Any git URL, or a Docker image. Nixpacks, the default builder, works out how to build the code; a Dockerfile works too. See Applications.Deploy and give it an address
Press Deploy and watch the Deployment log. Then on the Domains tab press Add a domain and Generate one for me for a free sslip.io address, or type your own host. See Domains.
A folder (CLI)
The CLI uploads a folder to an Application and follows its Deployment to the end. Your Organization needs a Server or a Cloud account first; the Project can be one you made in the console (the previous tab) or one the CLI makes for you. Then:
Install the CLI
You need Node 22 or newer.
npm install -g @octabyte-io/cloudgate@nextLog in
cloudgate loginOpen the address it prints, check the code and approve it in the console. Add
--instance <address>for a self-hosted instance; without it, the CLI logs in to the Hosted instance.Deploy the folder
In your project folder:
cloudgate deployThe first time, it asks which Project the folder belongs to, or offers Create a new Project, then whether it is one app or the whole Project, and remembers the answer. It leaves out what
.gitignorelists and your.envfiles, uploads the rest (later deploys send only what changed), and prints the Deployment log until the Deployment ends. Thencloudgate statusshows the Service and its Domains. See the CLI guide.
What you have now
A Project, with a production Environment, holding one running Service on a Server. The Service
has a Deployment with its log, and an address. From here:
- Add your own domain with HTTPS: Domains.
- Add a database and wire it in: Databases and Environment variables.
- Deploy on every git push, or keep the whole Project in a
cloudgate.yaml: Project config. - Let an AI agent deploy and read logs within limits you set: Agents.
What you cannot do yet
For a list of everything Cloudgate does and does not do, see What Cloudgate can and cannot do. The features page has the overview, and pricing the Hosted plans.
Questions
Do I need a domain name to start?
No. A free sslip.io address works straight away, over plain HTTP. Add your own domain later and Cloudgate gets a Let's Encrypt certificate for it.
Do I need my own server?
You need a Server or a Cloud account before anything can deploy. On the Hosted instance the wizard can buy one for you; otherwise bring any Ubuntu machine you can reach over SSH as root or a user with passwordless sudo.
Can a member who is not an owner or admin use the wizard?
Only with a Server that already exists. Adding or buying a Server needs an owner or admin, and the wizard tells a member to ask one.
How long does it take?
Buying a server and setting it up usually takes a few minutes, and you can leave the page while it carries on. Connecting your own server takes as long as its setup run: installing Docker, a Swarm and Traefik.
Something missing or wrong on this page? Email support@octabyte.io, or start a free trial and try it in the console.