Skip to content

Commit 7ec8857

Browse files
committed
Minor documentation verbiage updates
1 parent bfe3297 commit 7ec8857

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

docs/02-NGINX-Plus-Setup.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Take the following steps to set up NGINX Plus as the OpenID Connect relying part
3535

3636
```nginx
3737
map $x_client_id $idp_domain {
38-
default '{{Your-IDP-Domain}}';
38+
default '{{Edit-Your-IDP-Domain}}';
3939
}
4040
4141
map $x_client_id $oidc_authz_endpoint {
@@ -57,30 +57,33 @@ Take the following steps to set up NGINX Plus as the OpenID Connect relying part
5757
map $x_client_id $oidc_userinfo_endpoint {
5858
default https://$idp_domain/userinfo;
5959
}
60-
61-
map $x_client_id $oidc_client {
62-
default "{{edit-your-IdP-client-ID}}";
63-
}
64-
60+
6561
map $x_client_id $oidc_logout_query_params_enable {
6662
default 1; # 0: OIDC RP-initiated logout, 1: custom logout
6763
}
68-
64+
6965
map $x_client_id $oidc_logout_query_params {
7066
default '{
7167
"client_id": "$oidc_client",
7268
"returnTo" : "$redirect_base/_logout"
7369
}';
7470
}
75-
```
7671
77-
4. In the `oidc_idp.conf`, update `$oidc_client_secret`, and `oidc_pkce_enable`.
72+
```
7873

74+
4. In the `oidc_idp.conf`, update `$oidc_client` and then update `$oidc_client_secret`, and `oidc_pkce_enable`accordingly as shown in below Options.
75+
76+
```nginx
77+
map $x_client_id $oidc_client {
78+
default "{{Edit-Your-IdP-ClientID}}";
79+
}
80+
```
7981
- Option 1. Update the following configuration if you don't enable **PKCE**.
8082
8183
```nginx
84+
8285
map $x_client_id $oidc_client_secret {
83-
default "{{Your-IDP-Client-Secret}}";
86+
default "{{Edit-Your-IDP-ClientSecret}}";
8487
}
8588
8689
map $x_client_id $oidc_pkce_enable {
@@ -106,7 +109,12 @@ Take the following steps to set up NGINX Plus as the OpenID Connect relying part
106109
resolver 8.8.8.8; # For DNS lookup of IDP endpoint
107110
# 127.0.0.11; # For local Docker DNS lookup
108111
```
109-
112+
Note : If you update anything in the `oidc_nginx_server.conf` , reload nginx by using below command.
113+
114+
`````nginx
115+
sudo nginx -s reload
116+
`````
117+
110118
## Optional Configuration
111119

112120
This repo provides a sample container environment. So you can skip this step if you would like to locally test with a container.

0 commit comments

Comments
 (0)