docusaurus/platform_versioned_docs/version-1.8/using-airbyte/getting-started/oss-quickstart.md
import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"; import { faWindows } from "@fortawesome/free-brands-svg-icons";
This quickstart guides you through deploying a local instance of Airbyte Self-Managed Community, Airbyte's open source product. Setup only takes a few minutes, and you can start moving data immediately.
This quickstart is for most people who want to manage their own Airbyte instance. It assumes you have basic knowledge of command-line tools. It's also helpful, but not necessary, to understand the basics of Docker.
This quickstart shows you how to:
If you don't want to self-manage Airbyte, skip this guide. Sign up for an Airbyte Cloud trial and start syncing data now.
If you want to use Python to move data, Airbyte's Python library, PyAirbyte, might be the best fit for you. It's a good choice if you're using Jupyter Notebook or iterating on an early prototype for a large data project and don't need to run your own server.
For best performance, run Airbyte on a machine with 4 or more CPUs and at least 8-GB of memory. Airbyte also runs with 2 CPUs and 8-GB of memory in low-resource mode. This guide explains how to do both. Follow this Github discussion to up-vote and track progress toward supporting lower resource environments.
Install Docker Desktop on your machine, if you haven't already. Follow the steps for your operating system in Docker's online help, linked below.
- [Mac](https://docs.docker.com/desktop/install/mac-install/)
- [Windows](https://docs.docker.com/desktop/install/windows-install/)
- [Linux](https://docs.docker.com/desktop/install/linux-install/) (see [installations on headless virtual machines](#for-linux) for more options)
You don't need to do anything with Docker, but you do need to run it in the background. Once it's open, minimize it and proceed to Part 2.
:::info Why do you need Docker? Airbyte runs on Kubernetes. When you deploy Airbyte locally, it uses Docker to create a Kubernetes cluster on your computer. :::
If you're installing on a Linux headless virtual machine, it's easier to use Docker Engine instead of Docker Desktop. See the EC2 guide for an example.
abctl is Airbyte's command-line tool for deploying and managing Airbyte.
This is the best way to get abctl, but this method doesn't work on Windows.
Open a terminal and run the following command.
curl -LsfS https://get.airbyte.com | bash -
If your terminal asks you to enter your password, do so.
When installation completes, you see abctl install succeeded.
To install abctl yourself, follow the instructions for your operating system.
<Tabs defaultValue="abctl-mac"> <TabItem value="abctl-mac" label="Mac">Use Homebrew to install abctl.
Install Homebrew, if you haven't already.
Run the following commands after you install Homebrew.
brew tap airbytehq/tap
brew install abctl
Keep abctl up to date with Homebrew, too.
brew upgrade abctl
Verify your processor architecture.
uname -m
If the output is x86_64, you'll download the linux-amd64 release. If the output is aarch64 or similar, you'll download the linux-arm64 release.
Download the file that is compatible with your machine's processor architecture
<a class="abctl-download button button--primary" data-architecture="linux" href="https://github.com/airbytehq/abctl/releases/latest" target="_blank" download>Latest Linux Release</a>
Extract the archive. This creates a directory named abctl, which contains the executable and other needed files.
tar -xvzf {name-of-file-downloaded.linux-*.tar.gz}
Make the extracted executable accessible. This allows you to run abctl as a command.
chmod +x abctl/abctl
Add abctl to your PATH. This allows you to run abctl from any directory in your terminal.
sudo mv abctl /usr/local/bin
Verify the installation. If this command prints the installed version of abctl, you can now use it to manage a local Airbyte instance.
abctl version
Verify your processor architecture.
Press <kbd><FontAwesomeIcon icon={faWindows} /> Windows</kbd> + <kbd>I</kbd>.
Click System > About.
Next to Processor, if it says AMD, you'll download the windows-amd64 release. If the output is ARM or similar, you'll download the windows-arm64 release.
Download the latest release of abctl.
<a class="abctl-download button button--primary" data-architecture="windows" href="https://github.com/airbytehq/abctl/releases/latest" target="_blank" download>Latest Windows Release</a>
Extract the zip file to a destination of your choice. This creates a folder containing the abctl executable and other required files. Copy the filepath because you'll need this in a moment.
Add the executable to your Path environment variable.
Click <FontAwesomeIcon icon={faWindows} /> Start and type environment.
Click Edit the system environment variables. The System Properties opens.
Click Environment Variables.
Find the Path variable and click Edit.
Click New, then paste the file path you saved in step 3.
Click OK, then click OK, then close the System Properties.
Open a new Command Prompt or PowerShell window. Changes to your Path variable only take effect in a new Window.
Verify abctl is installed correctly. If this command prints the installed version of abctl, you can now use it to manage a local Airbyte instance.
abctl version
Open Docker Desktop, which you installed previously.
Install Airbyte. To do this, open a terminal and run the following command.
abctl local install
Enter your Email and Organization name, then click Get Started.
Open Docker Desktop, which you installed previously.
Install Airbyte. To make Airbyte accessible outside localhost, specify the --host flag and provide a fully qualified domain name for Airbyte's host.
abctl local install --host example.com
You can turn off the secure cookies requirement if you're running on an insecure/non-HTTPS connection.
abctl local install --host example.com --insecure-cookies
Enter your Email and Organization name, then click Get Started.
Open Docker Desktop, which you installed previously.
Install Airbyte. To run Airbyte in a low-resource environment (fewer than 4 CPUs), specify the --low-resource-mode flag to the local install command. In low-resource mode, you are unable to access the Connector Builder.
abctl local install --low-resource-mode
Enter your Email and Organization name, then click Get Started.
:::note
If you see the warning Encountered an issue deploying Airbyte with the message Readiness probe failed: HTTP probe failed with statuscode: 503, allow installation to continue. You may need to allocate more resources for Airbyte, but installation can complete anyway. See Suggested resources.
:::
Installation may take up to 30 minutes depending on your internet connection. When it completes, your Airbyte instance opens in your web browser at http://localhost:8000, or the host you specified. As long as Docker Desktop is running in the background, use Airbyte by returning to that page. If you quit Docker Desktop and want to return to Airbyte, start Docker Desktop again. Once your containers are running, you can access Airbyte normally.
Airbyte asks you to log in with a password, but you don't have one yet. Proceed to Part 4 to get one.
To access your Airbyte instance, you need a password.
Get your default password.
abctl local credentials
This outputs something like this:
Credentials:
Email: [email protected]
// highlight-next-line
Password: a-random-password
Client-Id: 03ef466c-5558-4ca5-856b-4960ba7c161b
Client-Secret: m2UjnDO4iyBQ3IsRiy5GG3LaZWP6xs9I
Return to your browser and use that password to log into Airbyte.
Optional: Since you probably want to set your own password, you can change it any time.
abctl local credentials --password YourStrongPasswordExample
Your Airbyte server restarts. Once it finishes, use your new password to log into Airbyte again.
Congratulations! You have a fully functional instance of Airbyte running locally.
In Airbyte, you move data from sources to destinations. The relationship between a source and a destination is called a connection. Try moving some data on your local instance.
If you want to scale data movement in your organization, you probably need to move Airbyte off your local machine. You can deploy to a cloud provider like AWS, Google Cloud, or Azure. You can also use a single node like an AWS EC2 virtual machine. See the deployment guide to learn more.
To stop running all containers, but keep your data:
abctl local uninstall
To stop running containers and delete all data:
Uninstall Airbyte with the --persisted flag.
abctl local uninstall --persisted
Clear any remaining information abctl created.
rm -rf ~/.airbyte/abctl