Skip to content

chore: update documentation for admin login when built-in auth disabled #886

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
Mar 18, 2022
Merged

chore: update documentation for admin login when built-in auth disabled #886

Show file tree
Hide file tree
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
20 changes: 8 additions & 12 deletions admin/access-control/manage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ domain name for the OIDC token callback; use
`https://coder.my-company.com/oidc/callback`.

Once you've registered a Coder application with your OIDC provider, you'll need
to return to Coder and complete the setup process. Under **Admin** > **Manage** >
**Authentication**, ensure that you've selected **OpenID Connect** as the
authentication type. Then, provide the following parameters:
to return to Coder and complete the setup process. Under **Admin** >
**Manage** > **Authentication**, ensure that you've selected **OpenID Connect**
as the authentication type. Then, provide the following parameters:

- **Client ID**: The client ID for the Coder application you registered with the
OIDC provider
Expand All @@ -43,9 +43,9 @@ you:
tokens from `https://<yourDomain>/api/v0/users/me/oidc-access-token`
- **Additional Scopes:** Specify any scopes (beyond the default) that you would
like Coder to request from the authentication provider. By default, Coder
requests the scopes `openid`, `email`, and `profile`. Consult your
authentication provider's documentation for information on which scopes they
support.
requests the scopes `openid`, `email`, and `profile`. Consult your
authentication provider's documentation for information on which scopes they
support.
- **Disable built-in authentication:** Choose whether Coder removes the ability
to log in with an email/password option when you've enabled OIDC
authentication
Expand All @@ -62,9 +62,5 @@ To do so, navigate to **Manage** > **Admin** > **Authentication**. Then, toggle
**Disable built-in authentication** to **On** and click **Save preferences**.

[Site managers](users/user-roles#site-manager-permissions) can still use
built-in authentication. To view this option on the login page, add the
following query parameter to the URL you use to access your Coder deployment:

```text
/login?showAllAuthenticationTypes=1
```
built-in authentication. The **Admin Login** option will be visible on the login
page if built-in authentication is disabled.
2 changes: 1 addition & 1 deletion setup/kubernetes/aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ as a workspace deployment option, you'll need to
# ami: <your Ubuntu 20.04 AMI ID>
instanceType: <instance-type>
minSize: 1
mazSize: 2
maxSize: 2
desiredCapacity: 1
# Uncomment "overrideBootstrapCommand" if you are using a custom AMI
# overrideBootstrapCommand: |
Expand Down