Skip to content

Revert "docs: add setting email and password to the Quickstart documentation" #44434

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

Merged
merged 1 commit into from
Aug 19, 2024
Merged

Revert "docs: add setting email and password to the Quickstart documentation" #44434

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
33 changes: 10 additions & 23 deletions docs/using-airbyte/getting-started/oss-quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,28 +179,15 @@ abctl local credentials
Which should output something similar to:

```shell
Credentials:
Email: [email protected]
Password: random_password
Client-Id: 03ef466c-5558-4ca5-856b-4960ba7c161b
Client-Secret: m2UjnDO4iyBQ3IsRiy5GG3LaZWP6xs9I
{
"password": "password",
"client-id": "client_id",
"client-secret": "client_secret"
}
```

Use the value in the password field to authenticate to your new Airbyte instance.

You can set your email and password with the `credentials` command using `abctl`. To set your email you can run:

```shell
abctl local credentials --email [email protected]
```

To set your password you can run:

```shell
abctl local credentials --password new_password
```

If you wish to configure authentication when install abctl, follow the documentation on the [Authentication Integration](../../deploying-airbyte/integrations/authentication)
Use the value in the password field to authenticate to your new Airbyte instance. If you wish to configure
authentication follow the documentation on the [Authentication Integration](../../deploying-airbyte/integrations/authentication)
page.

As long as your Docker Desktop daemon is running in the background, you can use Airbyte by returning to [http://localhost:8000](http://localhost:8000).
Expand Down Expand Up @@ -367,14 +354,14 @@ For more advanced interactions (e.g. loading custom docker containers), read mor

### Unable To Locate User Email
:::note
In `abctl` [v0.11.0](https://github.com/airbytehq/abctl/releases/tag/v0.11.0), support for basic-auth was removed (as basic-auth support was removed from the `Airbyte Platform` in [v0.63.11](https://github.com/airbytehq/airbyte-platform/releases/tag/v0.63.11), and replaced with a more secure randomly generated password. When logging into Airbyte, the email (provided during registration) should be automatically populated. Both the email and the randomly generated password can be fetched by running `abctl local credentials`.
In `abctl` [v0.11.0](https://github.com/airbytehq/abctl/releases/tag/v0.11.0), support for basic-auth was removed (as basic-auth support was removed from the `Airbyte Platform` in [v0.63.11](https://github.com/airbytehq/airbyte-platform/releases/tag/v0.63.11), and replaced with a more secure randomly generated password. When logging into Airbyte, the email (provided during registration) should be automatically populated and the randomly generated password can be fetched by running `abctl local credentials`.

Airbyte is aware of situations where the email is not be automatically populated and we are working on addressing this within the `abctl` tool. In the interim, some manually steps are required to retrieve the authentication email address when it is unknown.
:::

If the email address for authenticating is not automatically populated, you can set an email with the following command:
If the email address for authenticating is not automatically populated, and you are unsure what the login email should be, the email can be retrieved from the database used by Airbyte. If using an external database, you will need to connect to the database and execute the query `SELECT "email" FROM "user"`. If using the database automatically included with the `abctl local install` command, you will need to install [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) and execute the following command:
```
abctl local credentials --email <[email protected]>
kubectl exec --kubeconfig ~/.airbyte/abctl/abctl.kubeconfig --namespace airbyte-abctl -it airbyte-db-0 -- psql -U airbyte -d db-airbyte -t -A -c 'SELECT "email" FROM "user"'
```

The password for this user can be retrieved by running `abctl local credentials`.
Expand Down
Loading