Skip to main content

Install

  • Register an account at https://app.airpipe.io/register.
  • Check your email to verify your account and log in.
  • You may use the hosted mode in the website interface itself or setup one of the self hosted modes as below.

Hosted (Managed)​

No further setup required once you have registered and verified your account. Easy!

Self Hosted (Unmanaged)​

To put the airpipe command on a Linux or Mac machine, then sign in:

  curl -fsSL https://download.airpipe.io/install.sh | sh
  airpipe login

To run it as a service, follow your platform's page below.

  • Generate an API Key at https://app.airpipe.io/apikeys. It is shown once, when you create it: copy it then.
  • We recommend using Linux as your primary production deployment, unless you have specific OS requirements.

Linux​

Mac​

Windows​

Binaries​

http://download.airpipe.io

Upgrading​

A self-hosted engine does not update itself, but from 3.22.0 it says when it is behind the current release: airpipe server logs the warning a newer Air Pipe is available at startup and once a day, airpipe cli logs it at most once a day, and airpipe --version prints it on stderr. It reads latest.version to know, and says nothing if it cannot. The app also lists each engine that reports with your API keys, and the version it runs, at Self-hosted agents, and flags any older than the current release (latest.version). Replicas that share one identity are listed as its processes, so a replica left on an old version shows too. An agent stays listed for 30 days after its last report. One that has not reported for 90 days, or enrolled and never reported in 7, is deleted the next time one of your agents enrols; if it starts again, it enrols again by itself.

  • Linux, installed with setup.sh: install the latest binary in place, then restart the service. (--update replaces the binary only; your configs and service are kept.)

    curl -s https://download.airpipe.io/setup.sh | sudo bash -s -- --update
    sudo systemctl restart airpipe

  • Mac, installed with setup.sh: the same, then restart the service.

    curl -s https://download.airpipe.io/setup.sh | sudo bash -s -- --update
    sudo launchctl kickstart -k system/com.airpipe

  • Docker: pull the new tag (airpipeio/agent:latest, or a version such as airpipeio/agent:3.23.1) and recreate the container.

  • Kubernetes: set the image tag in the deployment; the rollout replaces the pods one at a time.

  • Any other install: download the binary for your platform from https://download.airpipe.io/<version>/<os>/<arch>/airpipe and replace the old one.