Skip to content
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.

Sign up for GitHub

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

Update documentation based on slack message #26

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update documentation based on slack message #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions docs/deploying-airbyte/local-deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ BASIC_AUTH_PASSWORD=your_new_password_here

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.


### Setup Guide

**1. Check out system requirements from [Docker documentation](https://docs.docker.com/desktop/windows/install/).**
Expand All @@ -53,7 +54,15 @@ Make sure to select the options:
2. _Install required Windows components for WSL 2_
when prompted. After installation, it will require to reboot your computer.

**3. You're done!**
**3. Enable WSL2, Install Ubuntu 20.4, Windows Terminal, Upgrade Python to version 3.9, Install Git, Docker Desktop, and Docker Compose.**

**4. Enable Docker to run correctly on WSL by checking the “Use the WSL two-based engine” and “Enable Kubernetes” checkboxes in the Docker settings.**

**5. Navigate to your Airbyte directory in the terminal and run docker-compose up to spin up all Airbyte containers.**

**6. After the Airbyte banner shows up in the log, navigate to localhost:8000 to access the Airbyte UI.**

For more detailed instructions, please refer to the Airbyte Video Tutorial on YouTube: <https://www.youtube.com/watch?v=CtuU9Oi-6O8>

```bash
git clone https://github.com/airbytehq/airbyte.git
Expand All @@ -64,7 +73,6 @@ bash run-ab-platform.sh
- In your browser, just 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`. Once you deploy airbyte to your servers, be sure to [change these](/operator-guides/security).
- Start moving some data!

## Troubleshooting

If you encounter any issues, just connect to our [Slack](https://slack.airbyte.io). Our community will help! We also have a [troubleshooting](../troubleshooting/on-deploying.md) section in our docs for common problems.