Quick Start
Deploy your first application and reach it at a live URL in a few minutes.
This guide walks you through deploying an application from a Git repository or a container image, exposing a port, and opening its public URL.
Fast Path
Create an application, choose your source, set the port your app listens on, click Deploy app, then open the public URL.
Before You Start
- An Out Plane account, inside a team. New resources always belong to a team.
- One of: a connected GitHub repository, a public Git URL, or a container image reference.
- Three terms used below. An application is your running service. A deployment is one build and release of it. An instance is a single running copy. See How Out Plane works for the full model.
Create an Application
In the console, open Create → Application. Pick where your code or image comes from:
| Source | Use it for |
|---|---|
| GitHub | A repository from a connected GitHub account. |
| Public repo | Any public Git URL, with no GitHub App install needed. |
| Image | A prebuilt container image from any registry. |
Choose the Repository
Select GitHub and pick a repository. If you have not connected one yet, install
the Out Plane GitHub App, choose which repositories to grant, then come back and
select it. To deploy a public project without installing anything, use Public repo
and paste a URL like github.com/acme/web.
Configure the Build
- Name. Letters and numbers, 5 to 45 characters (for example
acme-web). - Branch. The branch to deploy.
- Build method. Out Plane detects a
Dockerfileand uses it. Otherwise Buildpacks builds the app for you. You can switch between them. - Root directory. Set this if your app lives in a subdirectory of the repo.
- Start command. Optional. Leave empty to use the image default.
Set the Port and Deploy
Under Ports, enter the port your app listens on and toggle it Public to get a URL. Then click Deploy app and watch the build and runtime logs. When the build finishes, the application becomes Running.
Your app must listen on 0.0.0.0 (not localhost) and on the port you exposed.
This is the most common reason a fresh deploy returns no response.
Enter the Image
Select Image and enter a reference in the form [registry/]name[:tag][@digest], for
example nginx:latest or ghcr.io/acme/api:1.4.0. Public images need no credential.
For a private image, add a registry credential
first and select it.
Set the Port and Deploy
Give the application a Name, then under Ports enter the port the image listens on and toggle it Public. Click Deploy app.
Open Your App
A public HTTP port gives your app a URL of the form:
https://{name}-{port}-{team}.outplane.appFor example, app acme-web on port 3000 in team acme is served at
https://acme-web-3000-acme.outplane.app. HTTPS is handled for you.
- Because the port is part of the hostname, each public port gets its own URL.
- A public TCP port instead gets a host and port assigned on its first deployment.
Open the URL in your browser to confirm the app responds.
Verify It's Running
- Logs. Follow build and runtime output on the Logs page.
- Terminal. Open a browser terminal to run commands inside a live instance.
Keep Deploying
For Git apps, pushing to the connected branch starts a new deployment automatically. No extra step.