Skip to content

Commit a279789

Browse files
authored
Fix environment variable naming inconsistencies in documentation (#7091)
Fixes #5983
1 parent e201a96 commit a279789

File tree

1 file changed

+34
-34
lines changed

1 file changed

+34
-34
lines changed

docs/modules/ROOT/pages/getting-started/assembly-configuring-registry-security.adoc

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ You can use the defaults for the other client settings.
9999
|The client ID for the {registry} REST API.
100100
|String
101101
|`registry-api`
102-
|`APICURIO_UI_AUTH_OIDC_CLIENT-ID`
102+
|`APICURIO_UI_AUTH_OIDC_CLIENT_ID`
103103
|The client ID for the {registry} web console.
104104
|String
105105
|`apicurio-registry`
@@ -116,7 +116,7 @@ TIP: For an example of setting environment variables on OpenShift, see xref:conf
116116
|Java system property
117117
|Type
118118
|Default value
119-
|`APICURIO_AUTH_ROLE-BASED-AUTHORIZATION`
119+
|`APICURIO_AUTH_ROLE_BASED_AUTHORIZATION`
120120
|`apicurio.auth.role-based-authorization`
121121
|Boolean
122122
|`false`
@@ -158,7 +158,7 @@ TIP: For an example of setting environment variables on OpenShift, see xref:conf
158158
|Java system property
159159
|Type
160160
|Default value
161-
|`APICURIO_AUTH_OWNER-ONLY-AUTHORIZATION_LIMIT-GROUP-ACCESS`
161+
|`APICURIO_AUTH_OWNER_ONLY_AUTHORIZATION_LIMIT_GROUP_ACCESS`
162162
|`apicurio.auth.owner-only-authorization.limit-group-access`
163163
|Boolean
164164
|`false`
@@ -226,13 +226,13 @@ IMPORTANT: You must register your {registry} application host as a *Redirect URI
226226
|Environment variable
227227
|Description
228228
|Setting
229-
|`QUARKUS_OIDC_CLIENT-ID`
229+
|`QUARKUS_OIDC_CLIENT_ID`
230230
|The client application ID for the {registry} REST API
231231
|Your Azure AD Application (client) ID obtained in step 5. For example: `123456a7-b8c9-012d-e3f4-5fg67h8i901`
232-
|`APICURIO_UI_AUTH_OIDC_CLIENT-ID`
232+
|`APICURIO_UI_AUTH_OIDC_CLIENT_ID`
233233
|The client application ID for the {registry} web console.
234234
|Your Azure AD Application (client) ID obtained in step 5. For example: `123456a7-b8c9-012d-e3f4-5fg67h8i901`
235-
|`QUARKUS_OIDC_AUTH-SERVER-URL`
235+
|`QUARKUS_OIDC_AUTH_SERVER_URL`
236236
|The URL for authentication in Azure AD.
237237
|Your Azure AD Application (tenant) ID obtained in step 6. For example: `\https://login.microsoftonline.com/1a2bc34d-567e-89f1-g0hi-1j2kl3m4no56/v2.0`.
238238
|===
@@ -245,19 +245,19 @@ IMPORTANT: You must register your {registry} application host as a *Redirect URI
245245
|Environment variable
246246
|Description
247247
|Setting
248-
|`QUARKUS_OIDC_TENANT-ENABLED`
248+
|`QUARKUS_OIDC_TENANT_ENABLED`
249249
|Enables authentication for {registry}.
250250
|`true`
251251
|`QUARKUS_HTTP_CORS_ORIGINS`
252252
|The host for your {registry} deployment for cross-origin resource sharing (CORS).
253253
|For example: `\https://test-registry.com`
254-
|`APICURIO_UI_AUTH_OIDC_REDIRECT-URI`
254+
|`APICURIO_UI_AUTH_OIDC_REDIRECT_URI`
255255
|The host for your {registry} web console.
256256
|For example: `\https://test-registry.com/ui`
257-
|`APICURIO_AUTH_ROLE-BASED-AUTHORIZATION`
257+
|`APICURIO_AUTH_ROLE_BASED_AUTHORIZATION`
258258
|Enables role-based authorization in {registry}.
259259
|`true`
260-
|`QUARKUS_OIDC_ROLES_ROLE-CLAIM-PATH`
260+
|`QUARKUS_OIDC_ROLES_ROLE_CLAIM_PATH`
261261
|The name of the claim in which Azure AD stores roles.
262262
|`roles`
263263
|===
@@ -329,19 +329,19 @@ You can set the following environment variables to configure authentication for
329329
|Description
330330
|Type
331331
|Default
332-
|`QUARKUS_OIDC_TENANT-ENABLED`
332+
|`QUARKUS_OIDC_TENANT_ENABLED`
333333
|Enables authentication for {registry}. When set to `true`, the environment variables that follow are required for authentication using {keycloak}.
334334
|String
335335
|`false`
336-
|`QUARKUS_OIDC_AUTH-SERVER-URL`
336+
|`QUARKUS_OIDC_AUTH_SERVER_URL`
337337
|The URL of the {keycloak} authentication server. For example, `\http://localhost:8080`.
338338
|String
339339
|-
340-
|`QUARKUS_OIDC_CLIENT-ID`
340+
|`QUARKUS_OIDC_CLIENT_ID`
341341
|The client ID for the {registry} REST API.
342342
|String
343343
|`registry-api`
344-
|`APICURIO_UI_AUTH_OIDC_CLIENT-ID`
344+
|`APICURIO_UI_AUTH_OIDC_CLIENT_ID`
345345
|The client ID for the {registry} web console.
346346
|String
347347
|`apicurio-registry`
@@ -356,7 +356,7 @@ You can set the following environment variables to configure authentication for
356356
|String
357357
|-
358358

359-
|`APICURIO_AUTH_ROLE-BASED-AUTHORIZATION`
359+
|`APICURIO_AUTH_ROLE_BASED_AUTHORIZATION`
360360
|Enables or disables role-based authorization.
361361
|Boolean
362362
|False
@@ -376,11 +376,11 @@ By default, {registry} supports authentication by using OpenID Connect. Users or
376376
|Java system property
377377
|Type
378378
|Default value
379-
|`QUARKUS_OIDC_TENANT-ENABLED`
379+
|`QUARKUS_OIDC_TENANT_ENABLED`
380380
|`quarkus.oidc.tenant-enabled`
381381
|Boolean
382382
|`false`
383-
|`APICURIO_AUTHN_BASIC-CLIENT-CREDENTIALS.ENABLED`
383+
|`APICURIO_AUTHN_BASIC_CLIENT_CREDENTIALS_ENABLED`
384384
|`apicurio.authn.basic-client-credentials.enabled`
385385
|Boolean
386386
|`false`
@@ -400,7 +400,7 @@ When using {keycloak}, it is best to set this configuration to your {keycloak} J
400400
|Java system property
401401
|Type
402402
|Default value
403-
|`APICURIO_AUTHN_BASIC-CLIENT-CREDENTIALS_CACHE-EXPIRATION`
403+
|`APICURIO_AUTHN_BASIC_CLIENT_CREDENTIALS_CACHE_EXPIRATION`
404404
|`apicurio.authn.basic-client-credentials.cache-expiration`
405405
|Integer
406406
|`10`
@@ -420,11 +420,11 @@ You can set the following options to `true` to enable role-based authorization i
420420
|Java system property
421421
|Type
422422
|Default value
423-
|`QUARKUS_OIDC_TENANT-ENABLED`
423+
|`QUARKUS_OIDC_TENANT_ENABLED`
424424
|`quarkus.oidc.tenant-enabled`
425425
|Boolean
426426
|`false`
427-
|`APICURIO_AUTH_ROLE-BASED-AUTHORIZATION`
427+
|`APICURIO_AUTH_ROLE_BASED_AUTHORIZATION`
428428
|`apicurio.auth.role-based-authorization`
429429
|Boolean
430430
|`false`
@@ -445,7 +445,7 @@ To enable using roles assigned by {keycloak}, set the following environment vari
445445
|Description
446446
|Type
447447
|Default
448-
|`APICURIO_AUTH_ROLE-SOURCE`
448+
|`APICURIO_AUTH_ROLE_SOURCE`
449449
| When set to `token`, user roles are taken from the authentication token.
450450
|String
451451
|`token`
@@ -503,7 +503,7 @@ To enable using roles managed internally by {registry}, set the following enviro
503503
|Description
504504
|Type
505505
|Default
506-
|`APICURIO_AUTH_ROLE-SOURCE`
506+
|`APICURIO_AUTH_ROLE_SOURCE`
507507
| When set to `application`, user roles are managed internally by {registry}.
508508
|String
509509
|`token`
@@ -528,27 +528,27 @@ Because there are no default admin users in {registry}, it is usually helpful to
528528
|Description
529529
|Type
530530
|Default
531-
|`APICURIO_AUTH_ADMIN-OVERRIDE_ENABLED`
531+
|`APICURIO_AUTH_ADMIN_OVERRIDE_ENABLED`
532532
| Enables the admin-override feature.
533533
|String
534534
|`false`
535-
|`APICURIO_AUTH_ADMIN-OVERRIDE_FROM`
535+
|`APICURIO_AUTH_ADMIN_OVERRIDE_FROM`
536536
|Where to look for admin-override information. Only `token` is currently supported.
537537
|String
538538
|`token`
539-
|`APICURIO_AUTH_ADMIN-OVERRIDE_TYPE`
539+
|`APICURIO_AUTH_ADMIN_OVERRIDE_TYPE`
540540
|The type of information used to determine if a user is an admin. Values depend on the value of the FROM variable, for example, `role` or `claim` when FROM is `token`.
541541
|String
542542
|`role`
543-
|`APICURIO_AUTH_ADMIN-OVERRIDE_ROLE`
543+
|`APICURIO_AUTH_ADMIN_OVERRIDE_ROLE`
544544
|The name of the role that indicates a user is an admin.
545545
|String
546546
|`sr-admin`
547-
|`APICURIO_AUTH_ADMIN-OVERRIDE_CLAIM`
547+
|`APICURIO_AUTH_ADMIN_OVERRIDE_CLAIM`
548548
|The name of a JWT token claim to use for determining admin-override.
549549
|String
550550
|`org-admin`
551-
|`APICURIO_AUTH_ADMIN-OVERRIDE_CLAIM-VALUE`
551+
|`APICURIO_AUTH_ADMIN_OVERRIDE_CLAIM_VALUE`
552552
|The value that the JWT token claim indicated by the CLAIM variable must be for the user to be granted admin-override.
553553
|String
554554
|`true`
@@ -577,12 +577,12 @@ You can set the following options to `true` to enable owner-only authorization f
577577
|Boolean
578578
|`false`
579579

580-
|`APICURIO_AUTH_OWNER-ONLY-AUTHORIZATION`
580+
|`APICURIO_AUTH_OWNER_ONLY_AUTHORIZATION`
581581
|`apicurio.auth.owner-only-authorization`
582582
|Boolean
583583
|`false`
584584

585-
|`APICURIO_AUTH_OWNER-ONLY-AUTHORIZATION_LIMIT-GROUP-ACCESS`
585+
|`APICURIO_AUTH_OWNER_ONLY_AUTHORIZATION_LIMIT_GROUP_ACCESS`
586586
|`apicurio.auth.owner-only-authorization.limit-group-access`
587587
|Boolean
588588
|`false`
@@ -607,11 +607,11 @@ To enable authenticated read access, you must first enable role-based authorizat
607607
|Java system property
608608
|Type
609609
|Default value
610-
|`QUARKUS_OIDC_TENANT-ENABLED`
610+
|`QUARKUS_OIDC_TENANT_ENABLED`
611611
|`quarkus.oidc.tenant-enabled`
612612
|Boolean
613613
|`false`
614-
|`APICURIO_AUTH_AUTHENTICATED-READ-ACCESS_ENABLED`
614+
|`APICURIO_AUTH_AUTHENTICATED_READ_ACCESS_ENABLED`
615615
|`apicurio.auth.authenticated-read-access.enabled`
616616
|Boolean
617617
|`false`
@@ -636,11 +636,11 @@ calls to the REST API, set the following options to `true`:
636636
|Java system property
637637
|Type
638638
|Default value
639-
|`QUARKUS_OIDC_TENANT-ENABLED`
639+
|`QUARKUS_OIDC_TENANT_ENABLED`
640640
|`quarkus.oidc.tenant-enabled`
641641
|Boolean
642642
|`false`
643-
|`APICURIO_AUTH_ANONYMOUS-READ-ACCESS_ENABLED`
643+
|`APICURIO_AUTH_ANONYMOUS_READ_ACCESS_ENABLED`
644644
|`apicurio.auth.anonymous-read-access.enabled`
645645
|Boolean
646646
|`false`

0 commit comments

Comments
 (0)