Skip to content

Commit 25663f1

Browse files
bgroffbgroff
authored
Update the local-deployment documentation to use the new abctl command. (#37104)
1 parent 5587167 commit 25663f1

File tree

3 files changed

+93
-49
lines changed

3 files changed

+93
-49
lines changed

‎docs/deploying-airbyte/docker-compose.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Docker Compose
2+
3+
:::info
4+
These instructions have been tested on MacOS, Windows 10 and Ubuntu 22.04.
5+
6+
:::
7+
8+
## Setup & launch Airbyte
9+
10+
- Install `Docker Engine` and the `Docker Compose plugin` on your workstation \(see [instructions](https://docs.docker.com/engine/install/)\).
11+
- After Docker is installed, you can immediately get started locally by running:
12+
13+
```bash
14+
# clone Airbyte from GitHub
15+
git clone --depth=1 https://github.com/airbytehq/airbyte.git
16+
17+
# switch into Airbyte directory
18+
cd airbyte
19+
20+
# start Airbyte
21+
./run-ab-platform.sh
22+
```
23+
24+
- In your browser, visit [http://localhost:8000](http://localhost:8000)
25+
- You will be asked for a username and password. By default, that's username `airbyte` and password `password`. Once you deploy Airbyte to your servers, be sure to change these in your `.env` file:
26+
27+
```yaml
28+
# Proxy Configuration
29+
# Set to empty values, e.g. "" to disable basic auth
30+
BASIC_AUTH_USERNAME=your_new_username_here
31+
BASIC_AUTH_PASSWORD=your_new_password_here
32+
```
33+
34+
- Start moving some data!
35+
36+
## Deploy on Windows
37+
38+
After installing the WSL 2 backend and Docker you should be able to run containers using Windows PowerShell. Additionally, as we note frequently, you will need `docker-compose` to build Airbyte from source. The suggested guide already installs `docker-compose` on Windows.
39+
40+
### Setup Guide
41+
42+
**1. Check out system requirements from [Docker documentation](https://docs.docker.com/desktop/windows/install/).**
43+
44+
Follow the steps on the system requirements, and necessarily, download and install the Linux kernel update package.
45+
46+
**2. Install Docker Desktop on Windows.**
47+
48+
Install [Docker Desktop](https://docs.docker.com/desktop/windows/install/) from here.
49+
50+
Make sure to select the options:
51+
52+
1. _Enable Hyper-V Windows Features_
53+
2. _Install required Windows components for WSL 2_
54+
when prompted. After installation, it will require to reboot your computer.
55+
56+
**3. You're done!**
57+
58+
```bash
59+
git clone --depth=1 https://github.com/airbytehq/airbyte.git
60+
cd airbyte
61+
bash run-ab-platform.sh
62+
```
63+
64+
- In your browser, just visit [http://localhost:8000](http://localhost:8000)
65+
- You will be asked for a username and password. By default, that's username `airbyte` and password `password`. Once you deploy airbyte to your servers, be sure to change these.
66+
- Start moving some data!
67+
68+
## Troubleshooting
69+
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:
70+
71+
- How long does it take to set up Airbyte?
72+
- Where can I see my data once I've run a sync?
73+
- Can I set a start time for my sync?
74+
75+
If you encounter any issues, check out [Getting Support](/community/getting-support) documentation
76+
for options how to get in touch with the community or us.

‎docs/deploying-airbyte/local-deployment.md

+12-49
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,31 @@
11
# Local Deployment
22

33
:::info
4-
These instructions have been tested on MacOS, Windows 10 and Ubuntu 22.04.
4+
These instructions have been tested on MacOS, Windows, Ubuntu and Fedora.
55

66
:::
77

88
## Setup & launch Airbyte
99

10-
- Install `Docker Engine` and the `Docker Compose plugin` on your workstation \(see [instructions](https://docs.docker.com/engine/install/)\).
11-
- After Docker is installed, you can immediately get started locally by running:
10+
- Install `Docker Desktop` \(see [instructions](https://docs.docker.com/desktop/install/mac-install/)\).
11+
- 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:
1213

1314
```bash
14-
# clone Airbyte from GitHub
15-
git clone --depth=1 https://github.com/airbytehq/airbyte.git
16-
17-
# switch into Airbyte directory
18-
cd airbyte
19-
20-
# start Airbyte
21-
./run-ab-platform.sh
22-
```
23-
24-
- In your browser, visit [http://localhost:8000](http://localhost:8000)
25-
- You will be asked for a username and password. By default, that's username `airbyte` and password `password`. Once you deploy Airbyte to your servers, be sure to change these in your `.env` file:
26-
27-
```yaml
28-
# Proxy Configuration
29-
# Set to empty values, e.g. "" to disable basic auth
30-
BASIC_AUTH_USERNAME=your_new_username_here
31-
BASIC_AUTH_PASSWORD=your_new_password_here
15+
abctl local install
3216
```
3317

34-
- Start moving some data!
35-
36-
## Deploy on Windows
37-
38-
After installing the WSL 2 backend and Docker you should be able to run containers using Windows PowerShell. Additionally, as we note frequently, you will need `docker-compose` to build Airbyte from source. The suggested guide already installs `docker-compose` on Windows.
39-
40-
### Setup Guide
41-
42-
**1. Check out system requirements from [Docker documentation](https://docs.docker.com/desktop/windows/install/).**
43-
44-
Follow the steps on the system requirements, and necessarily, download and install the Linux kernel update package.
45-
46-
**2. Install Docker Desktop on Windows.**
47-
48-
Install [Docker Desktop](https://docs.docker.com/desktop/windows/install/) from here.
49-
50-
Make sure to select the options:
51-
52-
1. _Enable Hyper-V Windows Features_
53-
2. _Install required Windows components for WSL 2_
54-
when prompted. After installation, it will require to reboot your computer.
55-
56-
**3. You're done!**
18+
- Your browser should open to the Airbyte Application, if it does not visit [http://localhost](http://localhost)
19+
- 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:
5720

5821
```bash
59-
git clone --depth=1 https://github.com/airbytehq/airbyte.git
60-
cd airbyte
61-
bash run-ab-platform.sh
22+
abctl local install --username foo --password bar
23+
24+
# Or as Environment Variables
25+
ABCTL_LOCAL_INSTALL_PASSWORD=foo
26+
ABCTL_LOCAL_INSTALL_USERNAME=bar
6227
```
6328

64-
- In your browser, just visit [http://localhost:8000](http://localhost:8000)
65-
- You will be asked for a username and password. By default, that's username `airbyte` and password `password`. Once you deploy airbyte to your servers, be sure to change these.
6629
- Start moving some data!
6730

6831
## Troubleshooting

‎docusaurus/sidebars.js

+5
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,11 @@ const deployAirbyte = {
330330
label: "On your local machine",
331331
id: "deploying-airbyte/local-deployment",
332332
},
333+
{
334+
type: "doc",
335+
label: "Using docker compose",
336+
id: "deploying-airbyte/docker-compose",
337+
},
333338
{
334339
type: "doc",
335340
label: "On AWS EC2",

0 commit comments

Comments
 (0)