Local Deployment
These instructions have been tested on MacOS, Windows 10 and Ubuntu 20.04.

  • Install Docker on your workstation (see instructions). Make sure you're on the latest version of docker-compose.
  • After Docker is installed, you can immediately get started locally by running:
git clone https://github.com/airbytehq/airbyte.git
cd airbyte
docker-compose up
If you're using Mac M1 (Apple Silicon) machines, you can run Airbyte locally only in dev mode and you need to set these environment variables in order to build Airbyte:
export DOCKER_BUILD_PLATFORM=linux/arm64
export DOCKER_BUILD_ARCH=arm64
export ALPINE_IMAGE=arm64v8/alpine:3.14
export POSTGRES_IMAGE=arm64v8/postgres:13-alpine
export JDK_VERSION=17
after setting up the environment variables you can start Airbyte locally by running:
VERSION=dev docker-compose up

After installing the WSL 2 backend and Docker you should be able to run containers using Windows PowerShell. Additionally, as we note frequently, you will need docker-compose to build Airbyte from source. The suggested guide already installs docker-compose on Windows.

1. Check out system requirements from Docker documentation.
Follow the steps on the system requirements, and necessarily, download and install the Linux kernel update package.
2. Install Docker Desktop on Windows.
Install Docker Desktop from here.
Make sure to select the options:
  1. 1.
    Enable Hyper-V Windows Features
  2. 2.
    Install required Windows components for WSL 2 when prompted. After installation, it will require to reboot your computer.
3. You're done!
git clone https://github.com/airbytehq/airbyte.git
cd airbyte
docker-compose up

I have a Mac with the M1 chip. Is it possible to run Airbyte?
Yes, you can run Airbyte in dev mode on Macs with M1 chip (see the note above). Some users using Macs with an M1 chip are facing some problems running Airbyte. The problem is related with the chip and Docker. Issue #2017 was created to follow up the problem, you can subscribe to it and get updates about the resolution. If you can successfully run Airbyte using a MacBook with the M1 chip, let us know so that we can share the process with the community!
Other issues
If you encounter any issues, just connect to our Slack. Our community will help! We also have a troubleshooting section in our docs for common problems.
Copy link
On this page
Setup & launch Airbyte
Deploy on Windows
Setup Guide