Skip to main content

Local Deployment

info

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

Setup & launch Airbyte

  • 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

Deploy on Windows

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.

Setup Guide

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. Enable Hyper-V Windows Features
  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

Troubleshooting

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.