diff --git a/docs/deploying-airbyte/local-deployment.md b/docs/deploying-airbyte/local-deployment.md index 07bd81857b6d8..8d69395844502 100644 --- a/docs/deploying-airbyte/local-deployment.md +++ b/docs/deploying-airbyte/local-deployment.md @@ -1,25 +1,53 @@ # 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](https://github.com/airbytehq/airbyte/issues) with the type 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](/deploying-airbyte/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 + +```bash +brew tap airbytehq/tap +brew install abctl +``` + +::: + - Install `Docker Desktop` \(see [instructions](https://docs.docker.com/desktop/install/mac-install/)\). - After `Docker Desktop` is installed, you must enable `Kubernetes` \(see [instructions](https://docs.docker.com/desktop/kubernetes/)\). -- Download the latest version of `abctl` from the [releases page](https://github.com/airbytehq/abctl/releases) and run the following command: +- If you did not use Brew to install `abctl` then download the latest version of `abctl` from the [releases page](https://github.com/airbytehq/abctl/releases) 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. + +::: + ```bash -abctl local install +./abctl local install ``` - Your browser should open to the Airbyte Application, if it does not visit [http://localhost](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: ```bash -abctl local install --username foo --password bar +./abctl local install --username foo --password bar # Or as Environment Variables ABCTL_LOCAL_INSTALL_PASSWORD=foo