Skip to content

Commit

Permalink
Update the quickstart guide to remove some unneeded warnings and noti…
Browse files Browse the repository at this point in the history
…ces. Add clarity to how the tool is intended to be used. (airbytehq#38536)
  • Loading branch information
bgroff authored May 22, 2024
1 parent 29633a4 commit af42c24
Show file tree
Hide file tree
Showing 7 changed files with 54 additions and 73 deletions.
2 changes: 1 addition & 1 deletion docs/contributing-to-airbyte/writing-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ To make complex changes or edit multiple files, edit the files on your local mac
cd airbyte
```

While cloning on Windows, you might encounter errors about long filenames. Refer to the instructions [here](../deploying-airbyte/local-deployment.md#handling-long-filename-error) to correct it.
While cloning on Windows, you might encounter errors about long filenames. Refer to the instructions [here](../deploying-airbyte/quickstart#handling-long-filename-error) to correct it.

3. Create a feature branch from which to make changes:

Expand Down
67 changes: 0 additions & 67 deletions docs/deploying-airbyte/local-deployment.md

This file was deleted.

48 changes: 48 additions & 0 deletions docs/deploying-airbyte/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Airbyte Quickstart

Airbyte has a single binary tool called `abctl` which can be used to quickly standup Airbyte.

## 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

```bash
brew tap airbytehq/tap
brew install abctl
```

:::

Then you can run Airbyte with the following command:

```bash
abctl local install
```

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

# Or as Environment Variables
ABCTL_LOCAL_INSTALL_PASSWORD=foo
ABCTL_LOCAL_INSTALL_USERNAME=bar
```

- Start moving some data!

## Troubleshooting

If you have any questions about the local setup and deployment process, head over to our [Getting Started FAQ](https://github.com/airbytehq/airbyte/discussions/categories/questions) on our Airbyte Forum that answers the following questions and more:

- How long does it take to set up Airbyte?
- Where can I see my data once I've run a sync?
- Can I set a start time for my sync?

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".
2 changes: 1 addition & 1 deletion docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Next, check out the [step-by-step tutorial](/using-airbyte/getting-started) to s

Browse the [connector catalog](/integrations/) to find the connector you want. If the connector is not yet supported on Airbyte Open Source, [build your own connector](/connector-development/).

Next, check out the [Airbyte Open Source QuickStart](/deploying-airbyte/local-deployment). Then learn how to [deploy](/deploying-airbyte/local-deployment) and [manage](/operator-guides/upgrading-airbyte) Airbyte Open Source in your cloud infrastructure.
Next, check out the [Airbyte Open Source QuickStart](/deploying-airbyte/quickstart). Then learn how to [deploy](/deploying-airbyte/quickstart) and [manage](/operator-guides/upgrading-airbyte) Airbyte Open Source in your cloud infrastructure.

## For Airbyte contributors

Expand Down
2 changes: 1 addition & 1 deletion docs/release_notes/april_2024.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Read more in our [Clear documentation](/operator-guides/reset).

- Reduced friction for large records. Airbyte's platform no longer limits how large a record from the source can be. Instead, each destination has their own unique limit constraints. When a destination receives a large record, the primary key and cursor will be retained, but all other data in the record will be nulled. Any modifications to the record will be stored within `airbyte_meta.changes` for your review within the destination.

- A new OSS [Quickstart](/deploying-airbyte/local-deployment) that automatically manages all install steps for you. Mac users can also use Brew to install the `abctl` command.
- A new OSS [Quickstart](/deploying-airbyte/quickstart) that automatically manages all install steps for you. Mac users can also use Brew to install the `abctl` command.

- (Self-Managed Enterprise only) Improvements to connection migrations. Any changes to authentication or ingress URL configurations can be saved without deleting state. The improvement also includes a backwards-compatible alternative to setting the webapp-url property through the airbyte.yml file.

Expand Down
2 changes: 1 addition & 1 deletion docs/using-airbyte/getting-started/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ When self-managing Airbyte, your data never leaves your premises. Get started im

With Airbyte Self-Managed Community (Open Source), you can use one of the following options in your infrastructure:

- [Local Deployment](/deploying-airbyte/local-deployment.md) (recommended when trying out Airbyte)
- [Local Deployment](/deploying-airbyte/quickstart.md) (recommended when trying out Airbyte)
- [On AWS](/deploying-airbyte/on-aws-ec2.md)
- [On Azure VM Cloud Shell](/deploying-airbyte/on-azure-vm-cloud-shell.md)
- [On Digital Ocean Droplet](/deploying-airbyte/on-digitalocean-droplet.md)
Expand Down
4 changes: 2 additions & 2 deletions docusaurus/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -396,8 +396,8 @@ const deployAirbyte = {
items: [
{
type: "doc",
label: "On your local machine",
id: "deploying-airbyte/local-deployment",
label: "Quickstart",
id: "deploying-airbyte/quickstart",
},
{
type: "doc",
Expand Down

0 comments on commit af42c24

Please sign in to comment.