Skip to content

Commit 4ba4dea

Browse files
authored
docs: add setting email and password to the Quickstart documentation (#44435)
1 parent a240846 commit 4ba4dea

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

docs/using-airbyte/getting-started/oss-quickstart.md

+23-10
Original file line numberDiff line numberDiff line change
@@ -179,15 +179,28 @@ abctl local credentials
179179
Which should output something similar to:
180180

181181
```shell
182-
{
183-
"password": "password",
184-
"client-id": "client_id",
185-
"client-secret": "client_secret"
186-
}
182+
Credentials:
183+
184+
Password: random_password
185+
Client-Id: 03ef466c-5558-4ca5-856b-4960ba7c161b
186+
Client-Secret: m2UjnDO4iyBQ3IsRiy5GG3LaZWP6xs9I
187187
```
188188

189-
Use the value in the password field to authenticate to your new Airbyte instance. If you wish to configure
190-
authentication follow the documentation on the [Authentication Integration](../../deploying-airbyte/integrations/authentication)
189+
Use the value in the password field to authenticate to your new Airbyte instance.
190+
191+
You can set your email and password with the `credentials` command using `abctl`. To set your email you can run:
192+
193+
```shell
194+
abctl local credentials --email [email protected]
195+
```
196+
197+
To set your password you can run:
198+
199+
```shell
200+
abctl local credentials --password new_password
201+
```
202+
203+
If you wish to configure authentication when install abctl, follow the documentation on the [Authentication Integration](../../deploying-airbyte/integrations/authentication)
191204
page.
192205

193206
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).
@@ -354,14 +367,14 @@ For more advanced interactions (e.g. loading custom docker containers), read mor
354367

355368
### Unable To Locate User Email
356369
:::note
357-
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`.
370+
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`.
358371

359372
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.
360373
:::
361374

362-
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:
375+
If the email address for authenticating is not automatically populated, you can set an email with the following command:
363376
```
364-
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"'
377+
abctl local credentials --email <[email protected]>
365378
```
366379

367380
The password for this user can be retrieved by running `abctl local credentials`.

0 commit comments

Comments
 (0)