synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-09 11:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: simplify OIDC config instructions (#16266)

Browse Source
This commit is contained in:
M Atif Ali
2025-02-04 12:50:37 +05:00
committed by GitHub
parent dd6d57ed39
commit a15f06a7e3
1 changed files with 1 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/admin/users/oidc-auth.md
View File

@ -11,16 +11,7 @@ Your OIDC provider will ask you for the following parameter:
## Step 2: Configure Coder with the OpenID Connect credentials ## Step 2: Configure Coder with the OpenID Connect credentials
Navigate to your Coder host and run the following command to start up the Coder Set the following environment variables on your Coder deployment and restart Coder:
server:
```shell
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"
```
If you are running Coder as a system service, you can achieve the same result as
the command above by adding the following environment variables to the
`/etc/coder.d/coder.env` file:
```env ```env
CODER_OIDC_ISSUER_URL="https://issuer.corp.com" CODER_OIDC_ISSUER_URL="https://issuer.corp.com"
@ -29,30 +20,6 @@ CODER_OIDC_CLIENT_ID="533...des"
CODER_OIDC_CLIENT_SECRET="G0CSP...7qSM" CODER_OIDC_CLIENT_SECRET="G0CSP...7qSM"
``` ```
Once complete, run `sudo service coder restart` to reboot Coder.
If deploying Coder via Helm, you can set the above environment variables in the
`values.yaml` file as such:
```yaml
coder:
env:
- name: CODER_OIDC_ISSUER_URL
value: "https://issuer.corp.com"
- name: CODER_OIDC_EMAIL_DOMAIN
value: "your-domain-1,your-domain-2"
- name: CODER_OIDC_CLIENT_ID
value: "533...des"
- name: CODER_OIDC_CLIENT_SECRET
value: "G0CSP...7qSM"
```
To upgrade Coder, run:
```shell
helm upgrade <release-name> coder-v2/coder -n <namespace> -f values.yaml
```
## OIDC Claims ## OIDC Claims
When a user logs in for the first time via OIDC, Coder will merge both the When a user logs in for the first time via OIDC, Coder will merge both the