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.

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 login.md #1479

Merged
merged 1 commit into from
Nov 5, 2023
Merged
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs/docs/getting_started/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,22 @@ sidebar_position: 20

## Login as a user

1. Log in with username and password. By default, `minder` will run against a public stacklok cloud instance, but this can be changed in `config.yaml` in your local directory or using the `--gprc-host` and `--grpc-port` flags.
1. Log in with username and password. By default, `minder` will run against a public Stacklok cloud instance, but this can be changed in `config.yaml` in your local directory or using the `--gprc-host` and `--grpc-port` flags.

```bash
minder auth login
```

A new browser window will open, where you can register a new user and log in.

Once logged in
Once logged in:

2. Enroll a user with the given provider

```bash
minder provider enroll --provider github --group-id <group-id>
```

> __Note__: Provide the `--group-id` flag, if your user belongs to multiple groups. For this example, we will use the default group `1`, so we do not need to provide the flag.
> __Note__: Provide the `--group-id` flag if your user belongs to multiple groups. For this example, we will use the default group `1`, so we do not need to provide the flag.
>
A browser session will open, and you will be prompted to login to your GitHub. Once you have granted Minder access, you will be redirected back, and the user will be enrolled. The `minder` CLI application will report the session is complete.
A browser session will open, and you will be prompted to login to your GitHub account. Once you have granted Minder access, you will be redirected back, and the user will be enrolled. The `minder` CLI application will report the session is complete.