Skip to content

Commit af42c24

Browse files
authored
Update the quickstart guide to remove some unneeded warnings and notices. Add clarity to how the tool is intended to be used. (#38536)
1 parent 29633a4 commit af42c24

File tree

7 files changed

+54
-73
lines changed

7 files changed

+54
-73
lines changed

docs/contributing-to-airbyte/writing-docs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ To make complex changes or edit multiple files, edit the files on your local mac
6060
cd airbyte
6161
```
6262

63-
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.
63+
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.
6464

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

docs/deploying-airbyte/local-deployment.md

-67
This file was deleted.

docs/deploying-airbyte/quickstart.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Airbyte Quickstart
2+
3+
Airbyte has a single binary tool called `abctl` which can be used to quickly standup Airbyte.
4+
5+
## Setup & launch Airbyte
6+
7+
- Install `Docker Desktop` \(see [instructions](https://docs.docker.com/desktop/install/mac-install/)\).
8+
- Download the latest version of `abctl` from the [releases page](https://github.com/airbytehq/abctl/releases)
9+
10+
:::info
11+
Mac users can use Brew to install the `abctl` command
12+
13+
```bash
14+
brew tap airbytehq/tap
15+
brew install abctl
16+
```
17+
18+
:::
19+
20+
Then you can run Airbyte with the following command:
21+
22+
```bash
23+
abctl local install
24+
```
25+
26+
- Your browser should open to the Airbyte Application, if it does not visit [http://localhost:8000](http://localhost:8000)
27+
- 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:
28+
29+
```bash
30+
abctl local install --username foo --password bar
31+
32+
# Or as Environment Variables
33+
ABCTL_LOCAL_INSTALL_PASSWORD=foo
34+
ABCTL_LOCAL_INSTALL_USERNAME=bar
35+
```
36+
37+
- Start moving some data!
38+
39+
## Troubleshooting
40+
41+
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:
42+
43+
- How long does it take to set up Airbyte?
44+
- Where can I see my data once I've run a sync?
45+
- Can I set a start time for my sync?
46+
47+
If you find an issue with the `abctl` command, please report it as a github
48+
issue [here](https://github.com/airbytehq/airbyte/issues) with the type of "🐛 [abctl] Report an issue with the abctl tool".

docs/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Next, check out the [step-by-step tutorial](/using-airbyte/getting-started) to s
3030

3131
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/).
3232

33-
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.
33+
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.
3434

3535
## For Airbyte contributors
3636

docs/release_notes/april_2024.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Read more in our [Clear documentation](/operator-guides/reset).
2222

2323
- 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.
2424

25-
- 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.
25+
- 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.
2626

2727
- (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.
2828

docs/using-airbyte/getting-started/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ When self-managing Airbyte, your data never leaves your premises. Get started im
2828

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

31-
- [Local Deployment](/deploying-airbyte/local-deployment.md) (recommended when trying out Airbyte)
31+
- [Local Deployment](/deploying-airbyte/quickstart.md) (recommended when trying out Airbyte)
3232
- [On AWS](/deploying-airbyte/on-aws-ec2.md)
3333
- [On Azure VM Cloud Shell](/deploying-airbyte/on-azure-vm-cloud-shell.md)
3434
- [On Digital Ocean Droplet](/deploying-airbyte/on-digitalocean-droplet.md)

docusaurus/sidebars.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -396,8 +396,8 @@ const deployAirbyte = {
396396
items: [
397397
{
398398
type: "doc",
399-
label: "On your local machine",
400-
id: "deploying-airbyte/local-deployment",
399+
label: "Quickstart",
400+
id: "deploying-airbyte/quickstart",
401401
},
402402
{
403403
type: "doc",

0 commit comments

Comments
 (0)