Skip to content

Update the quickstart guide to remove some unneeded warnings and notices. Add clarity to how the tool is intended to be used. #38536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 22, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 8 additions & 31 deletions docs/deploying-airbyte/local-deployment.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,10 @@
# 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 "🐛 [abctl] Report an issue with the abctl tool".

:::

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

This tool is intended to get Airbyte running as quickly as possible with no additional configuration necessary.
Additional configuration options may be added in the future, however, if you need additional configuration options now, use the
docker compose solution by following the instructions for the `run_ab_platform.sh` script [here](/deploying-airbyte/docker-compose).

:::
# Airbyte Quickstart

## Setup & launch Airbyte

- Install `Docker Desktop` \(see [instructions](https://docs.docker.com/desktop/install/mac-install/)\).
- Download the latest version of `abctl` from the [releases page](https://github.com/airbytehq/abctl/releases)

:::info
Mac users can use Brew to install the `abctl` command

Expand All @@ -28,25 +15,15 @@ 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/)\).
- 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
Expand All @@ -63,5 +40,5 @@ If you have any questions about the local setup and deployment process, head ove
- 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](/community/getting-support) documentation
for options how to get in touch with the community or us.
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 "🐛 [abctl] Report an issue with the abctl tool".
Loading