Architecture
Aeroplane is a control plane that runs on your server and manages a Docker-based deployment runtime.
Main Pieces
Section titled “Main Pieces”- The Aeroplane app stores projects, services, deployments, domains, environment variables, backup metadata, import sources, and users.
- Docker runs application containers, worker containers, database containers, and short-lived helper containers for builds, backups, imports, restores, and updates.
- BuildKit builds source services through Railpack.
- Caddy routes HTTP traffic, handles certificates, serves the control plane hostname, serves generated service hostnames, and routes custom domains.
- The runtime network lets app services and database services talk privately inside Docker.
DATA_DIRstores Aeroplane state such as static sites, database backups, Postgres TLS assets, system settings, update history, maintenance history, and generated Caddy config.
Request Flow
Section titled “Request Flow”For a web service, public traffic reaches Caddy first. Caddy routes the request to the service’s active container port. Aeroplane updates that active port during successful deployments, then reloads Caddy.
For static output, Caddy serves files from Aeroplane’s static site directory.
For workers, there is no public route. Aeroplane starts the container and checks that the process stays running.
Build Flow
Section titled “Build Flow”Git services are cloned from GitHub or a direct Git URL. Aeroplane passes the selected branch, root directory, install command, build command, start command, runtime mode, internal port, and static output setting into the build and deployment flow.
Source services use BuildKit and Railpack. Docker image services skip the source build and pull the configured image directly.
Database Flow
Section titled “Database Flow”Database services run as Docker containers with persistent Docker volumes. Aeroplane creates connection variables, generated public hostnames when a root domain exists, and Caddy routes for public database access where supported.
PostgreSQL-family services can enable logical replication. Aeroplane also creates Postgres TLS assets for public database hostnames.
Backup Flow
Section titled “Backup Flow”Database backups are created locally first. Depending on the selected storage target, Aeroplane then keeps the local disk file, uploads it to Cloudflare R2, or does both.
Enabled automatic schedules run in the background for daily, weekly, or monthly backups. Manual backups run from the database Backups tab.
Migration Flow
Section titled “Migration Flow”Aeroplane supports two migration paths:
- Railway import, which reads Railway projects and recreates supported services in Aeroplane.
- Aeroplane migration bundles, which export a whole Aeroplane instance into an encrypted
.aeroplanefile and restore it into another server.
Those paths solve different problems. Railway import translates a Railway project into Aeroplane services. Aeroplane bundles move an Aeroplane instance between servers.