1
0
mirror of synced 2026-01-01 00:02:54 -05:00
Files
airbyte/docs/deploying-airbyte/local-deployment.md
Evan Tahler 3d053e32ee Use Nginx + Basic Auth to secure OSS Airbyte (#17694)
* Use Nginx + Basic Auth to secure OSS Airbyte

* use local passwords

* Use gradle builds

* K8s setup and source values from ENV

* note about disabling

* add back defaults

* custom 401 page

* update http message

* update docs

* remove kube files

* additional doc updates

* Add a test suite

* fix failure exit codes

* doc updates

* Add docs

* bump to re-test

* add more sleep in tests for CI

* better sleep in test

* Update docs/operator-guides/security.md

Co-authored-by: Davin Chia <davinchia@gmail.com>

* PR updates

* test comment

* change test host on CI

* update tests and nginx to boot without backend

* proxy updates for docker DNS

* simpler test for uptime

* acceptance test skips PWs

* remove resolver madness

* fixup tests

* more proxy_pass revert

* update acceptance test exit codes

* relax test expectations

* add temporal mount back for testing

* Update docs/operator-guides/security.md

Co-authored-by: swyx <shawnthe1@gmail.com>

* Update airbyte-proxy/401.html

Co-authored-by: swyx <shawnthe1@gmail.com>

* more doc updates

* Octavia CLI uses Basic Auth  (#17982)

* [WIP] Octavia CLI uses Basic Auth

* readme

* augustin: add basic auth headers to clien

* augustin: add basic auth headers to client

* tests passing

* lint

* docs

* Move monkey patch to test

* coerce headers into strings

* monkey patch get_basic_auth_token

Co-authored-by: alafanechere <augustin.lafanechere@gmail.com>

* fix launch permissions

* Keep worker port internal

* more readme

Co-authored-by: Davin Chia <davinchia@gmail.com>
Co-authored-by: swyx <shawnthe1@gmail.com>
Co-authored-by: alafanechere <augustin.lafanechere@gmail.com>
2022-10-19 15:52:01 -07:00

2.5 KiB

Local Deployment

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

:::

Setup & launch Airbyte

  • Install Docker on your workstation (see instructions). Make sure you're on the latest version of docker-compose.
  • After Docker is installed, you can immediately get started locally by running:
git clone https://github.com/airbytehq/airbyte.git
cd airbyte
docker-compose up
  • In your browser, just visit 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:
# Proxy Configuration
# Set to empty values, e.g. "" to disable basic auth
BASIC_AUTH_USERNAME=your_new_username_here
BASIC_AUTH_PASSWORD=your_new_password_here
  • Start moving some data!

Deploy on Windows

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.

Follow the steps on the system requirements, and necessarily, download and install the Linux kernel update package.

2. Install Docker Desktop on Windows.

Install Docker Desktop from here.

Make sure to select the options:

  1. Enable Hyper-V Windows Features
  2. Install required Windows components for WSL 2
    when prompted. After installation, it will require to reboot your computer.

3. You're done!

git clone https://github.com/airbytehq/airbyte.git
cd airbyte
docker-compose up
  • In your browser, just visit 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.
  • Start moving some data!

Troubleshooting

If you encounter any issues, just connect to our Slack. Our community will help! We also have a troubleshooting section in our docs for common problems.