Skip to content

Commit a15f06a

Browse files
authored
docs: simplify OIDC config instructions (#16266)
1 parent dd6d57e commit a15f06a

File tree

1 file changed

+1
-34
lines changed

1 file changed

+1
-34
lines changed

docs/admin/users/oidc-auth.md

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,7 @@ Your OIDC provider will ask you for the following parameter:
1111

1212
## Step 2: Configure Coder with the OpenID Connect credentials
1313

14-
Navigate to your Coder host and run the following command to start up the Coder
15-
server:
16-
17-
```shell
18-
coder server --oidc-issuer-url="https://issuer.corp.com" --oidc-email-domain="your-domain-1,your-domain-2" --oidc-client-id="533...des" --oidc-client-secret="G0CSP...7qSM"
19-
```
20-
21-
If you are running Coder as a system service, you can achieve the same result as
22-
the command above by adding the following environment variables to the
23-
`/etc/coder.d/coder.env` file:
14+
Set the following environment variables on your Coder deployment and restart Coder:
2415

2516
```env
2617
CODER_OIDC_ISSUER_URL="https://issuer.corp.com"
@@ -29,30 +20,6 @@ CODER_OIDC_CLIENT_ID="533...des"
2920
CODER_OIDC_CLIENT_SECRET="G0CSP...7qSM"
3021
```
3122

32-
Once complete, run `sudo service coder restart` to reboot Coder.
33-
34-
If deploying Coder via Helm, you can set the above environment variables in the
35-
`values.yaml` file as such:
36-
37-
```yaml
38-
coder:
39-
env:
40-
- name: CODER_OIDC_ISSUER_URL
41-
value: "https://issuer.corp.com"
42-
- name: CODER_OIDC_EMAIL_DOMAIN
43-
value: "your-domain-1,your-domain-2"
44-
- name: CODER_OIDC_CLIENT_ID
45-
value: "533...des"
46-
- name: CODER_OIDC_CLIENT_SECRET
47-
value: "G0CSP...7qSM"
48-
```
49-
50-
To upgrade Coder, run:
51-
52-
```shell
53-
helm upgrade <release-name> coder-v2/coder -n <namespace> -f values.yaml
54-
```
55-
5623
## OIDC Claims
5724

5825
When a user logs in for the first time via OIDC, Coder will merge both the

0 commit comments

Comments
 (0)