Skip to main content

Local Deployment

warning

This tool is in active development. Airbyte strives to provide high quality, reliable software, however there may be bugs or usability issues with this command. If you find an issue with the abctl command, please report it as a github issue here with the tpye of "Issue: 🤷 Others issues requests..." please add the area/quickstart label.

info

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

If you are looking for instructions for the run_ab_platform.sh script, please refer to the Docker Compose documentation. Note that the abctl command does not currently allow for customizations via .env files.

Setup & launch Airbyte​

info

Mac users can use Brew to install the abctl command

brew tap airbytehq/tap
brew install abctl
  • Install Docker Desktop (see instructions).
  • After Docker Desktop is installed, you must enable Kubernetes (see instructions).
  • If you did not use Brew to install abctl then download the latest version of abctl from the releases page and run the following command:
info

Mac users may need to use the finder and Open With > Terminal to run the abctl command. After the first run users should be able to run the command from the terminal. Airbyte suggests mac users to use brew if it is available.

./abctl local install
  • Your browser should open to the Airbyte Application, if it does not visit http://localhost
  • You will be asked for a username and password. By default, that's username airbyte and password password. You can set these values through command line flags or environment variables. For example, to set the username and password to foo and bar respectively, you can run the following command:
./abctl local install --username foo --password bar

# Or as Environment Variables
ABCTL_LOCAL_INSTALL_PASSWORD=foo
ABCTL_LOCAL_INSTALL_USERNAME=bar
  • Start moving some data!

Troubleshooting​

If you have any questions about the local setup and deployment process, head over to our Getting Started FAQ on our Airbyte Forum that answers the following questions and more:

  • How long does it take to set up Airbyte?
  • Where can I see my data once I've run a sync?
  • Can I set a start time for my sync?

If you encounter any issues, check out Getting Support documentation for options how to get in touch with the community or us.

Was this page helpful?