Quick Start
Deploy your first application on Out Plane in under 5 minutes
This guide walks you through deploying your first application on Out Plane—from sign-up to a live URL.
Prerequisites
Before you begin:
- A GitHub account with at least one repository
- Application code ready to deploy (Node.js, Python, Go, or any Dockerized app)
Step 1: Sign Up & Create Team
- Go to console.outplane.com
- Click Sign in with GitHub and authorize Out Plane
- Create your first team—choose a name and slug
Teams isolate resources and billing. You can create multiple teams for different projects or organizations.
Step 2: Install GitHub App
Out Plane needs access to your repositories to deploy code.
- From the Applications page, click Deploy Application
- Click Install GitHub App when prompted
- Select repository access:
- All repositories — Access all current and future repos
- Select repositories — Choose specific repos
- Click Install to complete
You'll be redirected back to Out Plane automatically.
Step 3: Create Application
Select Repository
- Choose a repository from the list
- Select the branch to deploy (defaults to
mainormaster) - Set root directory if your app is in a subdirectory (default:
/)
Configure Build
| Setting | Description |
|---|---|
| Build Method | Dockerfile (use your Dockerfile) or Buildpack (auto-detect) |
| App Name | Unique identifier, used in your default domain |
| Port | Port your application listens on (e.g., 3000, 8080) |
Select Resources
| Instance | vCPU | RAM | Notes |
|---|---|---|---|
| op-20 | 0.5 | 512 MB | Free tier, for testing |
| op-46 | 1 | 1 GB | Small production apps |
| op-82 | 2 | 2 GB | Medium workloads |
| op-94 | 4 | 4 GB | High-performance |
Configure Scaling
- Min Scale: Set to
0for scale-to-zero (serverless), or1+for always-on - Max Scale: Maximum instances under load (1-10)
Add Environment Variables (Optional)
Click Add Variable to set environment variables:
NODE_ENV=production
DATABASE_URL=postgresql://user:pass@host/db
API_KEY=your-secret-keyEnvironment variables are encrypted at rest and injected at runtime.
Step 4: Deploy
Click Create Application to start the deployment.
Out Plane will:
- Clone your repository
- Build a container image (Dockerfile or Buildpack)
- Deploy to the infrastructure
- Provision your domain with SSL
Monitor Build Progress
The deployment page shows real-time build logs. Typical deployments take 2-5 minutes.
| Status | Meaning |
|---|---|
| Queued | Waiting for build resources |
| Building | Installing dependencies, building container |
| Deploying | Pushing to infrastructure |
| Ready | Live and serving traffic |
| Failed | Error occurred—check build logs |
Step 5: Access Your Application
Once the status shows Ready:
- Go to the application Overview tab
- Find your domain:
yourapp.outplane.app - Click to open your live application
You'll also see:
- Internal URL for service-to-service communication
- Last commit that was deployed
- Configuration summary
Next Steps
Now that your application is running:
| Task | Where |
|---|---|
| View runtime logs | Application → Logs tab |
| View HTTP requests | Application → HTTP Logs tab |
| Add custom domain | Domains page |
| Manage environment variables | Application → Settings → Environment |
| Invite team members | Settings → Members |
| Create a database | Databases page |
Troubleshooting
Build Failed
- Check the build logs for error messages
- Verify your
Dockerfileorpackage.jsonis correct - Ensure all dependencies are listed
- Check that environment variables are set
Application Not Starting
- Verify the port matches your application's listen port
- Check runtime logs for errors
- Ensure your app responds to HTTP requests on the configured port
Can't See Repository
- Go to GitHub → Settings → Applications → Out Plane
- Click Configure and grant access to the repository
- Refresh the repository list in Out Plane
Learn More
- Applications — Full application management guide
- Application Detail — Logs, deployments, and settings
- Databases — Set up managed PostgreSQL
- Domains — Custom domain configuration
- Monitoring — Cross-application log monitoring