Skip to content
Aeroplane Docs

Aeroplane Docs

Install the control plane, wire DNS, GitHub, R2, migrations, databases, and concurrent deployments from your own server.
Start install Migrate from Railway

Choose Your Path

Section titled “Choose Your Path”
Install Aeroplane Run the installer, see what gets created under /opt/aeroplane, and learn the first host commands to keep nearby.
Finish browser onboarding Create the owner account, set domains, connect GitHub, choose R2 backups, or restore from a migration bundle.
Deploy services Run GitHub repos, direct Git URLs, Docker images, web apps, workers, and static output.
Migrate from Railway Import Railway projects, recreate services, map variables, deploy databases first, and pull Postgres or Redis data.
Back up databases Use disk, R2, or both; schedule daily, weekly, and monthly backups; restore or download when needed.
Tune deployment concurrency Understand queued, building, running, aborted, and superseded deployments, plus the global concurrency limit.
Open the source Review the application code, installer, Docker setup, and server runtime that power Aeroplane.

Before You Install

Section titled “Before You Install”
  • Use a server you control, preferably a fresh Ubuntu or Debian host.
  • Keep ports 80 and 443 available for Caddy.
  • Decide the dashboard hostname, for example pilot.example.com.
  • Decide the wildcard service root, for example *.pilot.example.com.
  • Create a GitHub App when you want repository-based deployments and push webhooks.
  • Create a Cloudflare R2 bucket or token when you want off-server database backups.
  • Export a .aeroplane bundle first if you are moving from another Aeroplane instance.

Common Sequences

Section titled “Common Sequences”

For a new server, read Install Aeroplane first, then Browser Onboarding, then First Project.

For a first app, start with Source Services, then wire its hostname with Domains.

For a Railway move, start with Railway Import, then use Database Data Imports for Postgres and Redis follow-up imports.

For resilience, connect R2 Storage, choose Database Backups, and review Restore and Download.

What Aeroplane Manages

Section titled “What Aeroplane Manages”

Aeroplane runs a self-hosted control plane on your server. It coordinates GitHub-connected app services, direct Git URL services, prebuilt Docker images, Railpack and BuildKit builds, Docker workloads, Caddy routes, generated service domains, custom domains, environment variables, deployment logs, runtime logs, database access, database backups, Railway imports, encrypted migration bundles, R2 storage, DNS provider automation, system maintenance, updates, and deployment concurrency.