Skip to main content

00 - Setup

This tutorial is designed to take you through the key features and functionality of Air Pipe.

The features and functionalities demonstrated here are non-exhaustive, so please review the complete documentation and configuration to understand all the available capabilities.

Requirements​

  • Registered and verified account
  • Working computer
Hosted / Managed

The easiest way to complete the tutorial is by using this mode which is running your configurations on the Air Pipe hosted backend itself. However some features are designed for self-hosted mode only, see the Self Hosted / Unmanaged section for further information.

  • Login to the platform https://app.airpipe.io and to start go to your configurations page.
  • Proceed to next step
Self Hosted / Unmanaged

It is incredibly easy to also use the self hosted version on your machine as well, as such we do recommend to use this where possible.

Why?​

  • Additional capabilities such as running commands, scripts, using environment variables, persisting database connections, tracing etc.
  • Deploy however and wherever you like, docker, k8s, on host etc.
  • Better performance with it deployed in your own environment
  • Control your data and security end to end

Install​

  • Retrieve or generate an API Key in your account https://app.airpipe.io/apikeys
  • Create a directory where you would like to test in, and run the following command: 
    curl -s https://download.airpipe.io/setup.sh | sudo bash -s -- --api-key enter-your-api-key-12345 --local
  • This will download the binary into the current directory and create a few more directories we will use later
  • Proceed to next step