1. Getting Started
  2. Quickstart

We support three deployment methods.

  1. VPC Deployment enables you to deploy a Pipebird box inside your pre-existing VPC.
  2. Default Deployment will deploy a public Pipebird box inside your default VPC.
  3. Local Deployment will deploy to your local machine.

We recommend Default Deployment if your app is not yet running within AWS.

Obtain a license key

Sign up to get a license key here - you’ll need to enter this key into the Quick Setup flow later in the process.

VPC Deployment

To deploy within an existing VPC click here.

Default Deployment

For our default deployment strategy we will spin up Pipebird within a default subnet. In case you don’t have a default subnet, follow the below steps to create one.

First, install the aws-cli


Next, configure your aws account locally


Then, create a default subnet


Finally, to deploy Pipebird simply click here.

Pipebird’s server will be running on port 3000 of the newly created instance. You can find the code for the server in your absolute path: /pipebird.

Get secret key

After creating your EC2 instance, you will need to use the following command to create your pipebird-secret-key:


You can use this secret key bearer token defined in this file to make authorized requests against your Pipebird instance.



Check your CloudFormation stack and CloudTrail logs for details on why a build may have failed.

Still having issues? Feel free to shoot us an email at sales@pipebird.com

Local Deploy

Required environment variables are specified in lib/env.ts and .env.example - make sure to fill out DATABASE_URL before attempting to run migrations.

Pipebird requires Node >= 16, a running Postgres instance, and a running Redis server to function.

You can also run Pipebird locally after cloning the repo by running the following: