Skip to content

Commit 0ed20e5

Browse files
authored
Update the abctl Local Deployment documentation to clarify uses and installation methods (#37391)
1 parent e2c1abc commit 0ed20e5

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

docs/deploying-airbyte/local-deployment.md

+31-3
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,53 @@
11
# Local Deployment
22

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+
311
:::info
412
These instructions have been tested on MacOS, Windows, Ubuntu and Fedora.
513

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+
617
:::
718

819
## Setup & launch Airbyte
920

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+
1031
- Install `Docker Desktop` \(see [instructions](https://docs.docker.com/desktop/install/mac-install/)\).
1132
- 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+
1341

1442
```bash
15-
abctl local install
43+
./abctl local install
1644
```
1745

1846
- Your browser should open to the Airbyte Application, if it does not visit [http://localhost](http://localhost)
1947
- 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:
2048

2149
```bash
22-
abctl local install --username foo --password bar
50+
./abctl local install --username foo --password bar
2351

2452
# Or as Environment Variables
2553
ABCTL_LOCAL_INSTALL_PASSWORD=foo

0 commit comments

Comments
 (0)