Airplane Documentation

Welcome to the Airplane docs! These pages will cover lessons, references, and more to get you up and running on the Airplane platform.

Getting Started

Check out the Airplane Overview for background on what Airplane actually does and why we built it.

For a fast walkthrough that gives you a feel for Airplane, the Quickstart will get you deploying and running tasks in a few minutes.

Creating Tasks

Tasks are the core building blocks on Airplane. You can easily convert a SQL query you've been running into a SQL Task, or write and deploy your own JavaScript script as a task. See the relevant task documentation for details:

Resources

Resources are things like databases and external APIs that you want to connect to Airplane. Once configured, a resource can be attached to and used by various Tasks. A SQL task, for example, requires a PostgreSQL or MySQL resource to be attached in order to connect.

Airplane currently supports the following resources–support for a broader set of resources is under development and coming soon!

And More

Once you've set up the basics, the full Airplane platform offers permissions, notifications, and other integrations to provide a robust tooling platform.

You might be interested in:

  • Self-Host the Agent - if you have security and compliance requirements, you can self-host the Airplane agent to run tasks in your own network.

  • Whitelist Airplane IP Addresses - if you need to connect to resources behind a firewall, you'll need to allow connections from Airplane's IPs.

  • Slack Integration - Airplane's Slack integration makes it easy to get notifications, approve requests, and even execute tasks directly from Slack.

Don't see what you're looking for? Shoot us a note: [email protected].