|
1 | 1 | # Local Deployment
|
2 | 2 |
|
| 3 | +:::warning |
| 4 | +This tool is in active development. Airbyte strives to provide high quality, reliable software, however there may be |
| 5 | +bugs or usability issues with this command. If you find an issue with the `abctl` command, please report it as a github |
| 6 | +issue [here](https://github.com/airbytehq/airbyte/issues) with the type of "Issue: 🤷 Others issues requests..." please |
| 7 | +add the `area/quickstart` label. |
| 8 | + |
| 9 | +::: |
| 10 | + |
3 | 11 | :::info
|
4 | 12 | These instructions have been tested on MacOS, Windows, Ubuntu and Fedora.
|
5 | 13 |
|
| 14 | +If you are looking for instructions for the `run_ab_platform.sh` script, please refer to the [Docker Compose](/deploying-airbyte/docker-compose) documentation. |
| 15 | +Note that the `abctl` command does not currently allow for customizations via .env files. |
| 16 | + |
6 | 17 | :::
|
7 | 18 |
|
8 | 19 | ## Setup & launch Airbyte
|
9 | 20 |
|
| 21 | +:::info |
| 22 | +Mac users can use Brew to install the `abctl` command |
| 23 | + |
| 24 | +```bash |
| 25 | +brew tap airbytehq/tap |
| 26 | +brew install abctl |
| 27 | +``` |
| 28 | + |
| 29 | +::: |
| 30 | + |
10 | 31 | - Install `Docker Desktop` \(see [instructions](https://docs.docker.com/desktop/install/mac-install/)\).
|
11 | 32 | - After `Docker Desktop` is installed, you must enable `Kubernetes` \(see [instructions](https://docs.docker.com/desktop/kubernetes/)\).
|
12 |
| -- Download the latest version of `abctl` from the [releases page](https://github.com/airbytehq/abctl/releases) and run the following command: |
| 33 | +- 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: |
| 34 | + |
| 35 | +:::info |
| 36 | +Mac users may need to use the finder and Open With > Terminal to run the `abctl` command. After the first run |
| 37 | +users should be able to run the command from the terminal. Airbyte suggests mac users to use `brew` if it is available. |
| 38 | + |
| 39 | +::: |
| 40 | + |
13 | 41 |
|
14 | 42 | ```bash
|
15 |
| -abctl local install |
| 43 | +./abctl local install |
16 | 44 | ```
|
17 | 45 |
|
18 | 46 | - Your browser should open to the Airbyte Application, if it does not visit [http://localhost](http://localhost)
|
19 | 47 | - 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:
|
20 | 48 |
|
21 | 49 | ```bash
|
22 |
| -abctl local install --username foo --password bar |
| 50 | +./abctl local install --username foo --password bar |
23 | 51 |
|
24 | 52 | # Or as Environment Variables
|
25 | 53 | ABCTL_LOCAL_INSTALL_PASSWORD=foo
|
|
0 commit comments