Skip to content

Commit 69d7b0e

Browse files
authored
Update auth.md
update auth.md for IA suggestions
1 parent c8eacc6 commit 69d7b0e

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed

docs/admin/auth.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,35 @@
11
# Authentication
22

3-
![OIDC with Coder Sequence Diagram](../images/oidc-sequence-diagram.svg).
3+
```
4+
Insert an overview of authentication, include
5+
6+
1. Who is authenticating into what
7+
2. Users that are able to set up authentication.
8+
3. Include a link to get more details about User roles, https://coder.com/docs/admin/users.
9+
4. When its important to set up Authentication, right after install? everytime a new user is added? When deploying to a new enviroment (dev, production)?
10+
11+
```
412

5-
By default, Coder is accessible via password authentication. Coder does not
13+
> By default, Coder is accessible via password authentication. Coder does not
614
recommend using password authentication in production, and recommends using an
715
authentication provider with properly configured multi-factor authentication
816
(MFA). It is your responsibility to ensure the auth provider enforces MFA
917
correctly.
1018

11-
The following steps explain how to set up GitHub OAuth or OpenID Connect.
19+
```
20+
Depending on how long and distinct this information is, I'd recommend breaking the Authentication topic up into different pages to give readers information on how to set up the different Authentication methods. So, break up Password, Github, and OpenID Connect into seprate pages under Authentication heading and list the pages from most to least used or recommend authentication type.
21+
22+
Other sections to include in an Authentication section:
23+
* Any limitations or precautions to take if you change they Authentication method on a running platform
24+
25+
```
26+
27+
## Password authentication
28+
29+
```
30+
Add information about how password authentication works. Its mentioned in the note that recommends not to use password authentication in production, but the concept is never explained.
31+
```
32+
1233

1334
## GitHub
1435

@@ -508,6 +529,10 @@ Below are some details specific to individual OIDC providers.
508529

509530
### Keycloak
510531

532+
```
533+
Is there any testing or versioning that important to highlight for this information? Include a link to an related of set up docs for Keycloak.
534+
```
535+
511536
The access_type parameter has two possible values: "online" and "offline." By
512537
default, the value is set to "offline". This means that when a user
513538
authenticates using OIDC, the application requests offline access to the user's

0 commit comments

Comments
 (0)