Skip to content

Commit 52f95d0

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 51880de commit 52f95d0

File tree

7 files changed

+262
-6
lines changed

7 files changed

+262
-6
lines changed

‎_generated-doc/main/config/quarkus-agroal.adoc‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,90 @@ h|[.header-title]##Configuration property##
77
h|Type
88
h|Default
99

10+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-enabled[`quarkus.datasource.dev-ui.enabled`]##
11+
ifdef::add-copy-button-to-config-props[]
12+
config_property_copy_button:+++quarkus.datasource.dev-ui.enabled+++[]
13+
endif::add-copy-button-to-config-props[]
14+
15+
16+
[.description]
17+
--
18+
Activate or disable the dev ui page.
19+
20+
21+
ifdef::add-copy-button-to-env-var[]
22+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ENABLED+++[]
23+
endif::add-copy-button-to-env-var[]
24+
ifndef::add-copy-button-to-env-var[]
25+
Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ENABLED+++`
26+
endif::add-copy-button-to-env-var[]
27+
--
28+
|boolean
29+
|`true`
30+
31+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-allow-sql]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-allow-sql[`quarkus.datasource.dev-ui.allow-sql`]##
32+
ifdef::add-copy-button-to-config-props[]
33+
config_property_copy_button:+++quarkus.datasource.dev-ui.allow-sql+++[]
34+
endif::add-copy-button-to-config-props[]
35+
36+
37+
[.description]
38+
--
39+
Allow sql queries in the Dev UI page
40+
41+
42+
ifdef::add-copy-button-to-env-var[]
43+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ALLOW_SQL+++[]
44+
endif::add-copy-button-to-env-var[]
45+
ifndef::add-copy-button-to-env-var[]
46+
Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ALLOW_SQL+++`
47+
endif::add-copy-button-to-env-var[]
48+
--
49+
|boolean
50+
|`false`
51+
52+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-append-to-default-select]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-append-to-default-select[`quarkus.datasource.dev-ui.append-to-default-select`]##
53+
ifdef::add-copy-button-to-config-props[]
54+
config_property_copy_button:+++quarkus.datasource.dev-ui.append-to-default-select+++[]
55+
endif::add-copy-button-to-config-props[]
56+
57+
58+
[.description]
59+
--
60+
Append this to the select done to fetch the table values. eg: LIMIT 100 or TOP 100
61+
62+
63+
ifdef::add-copy-button-to-env-var[]
64+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_APPEND_TO_DEFAULT_SELECT+++[]
65+
endif::add-copy-button-to-env-var[]
66+
ifndef::add-copy-button-to-env-var[]
67+
Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_APPEND_TO_DEFAULT_SELECT+++`
68+
endif::add-copy-button-to-env-var[]
69+
--
70+
|string
71+
|
72+
73+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-allowed-db-host]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-allowed-db-host[`quarkus.datasource.dev-ui.allowed-db-host`]##
74+
ifdef::add-copy-button-to-config-props[]
75+
config_property_copy_button:+++quarkus.datasource.dev-ui.allowed-db-host+++[]
76+
endif::add-copy-button-to-config-props[]
77+
78+
79+
[.description]
80+
--
81+
Allowed database host. By default only localhost is allowed. Any provided host here will also be allowed
82+
83+
84+
ifdef::add-copy-button-to-env-var[]
85+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ALLOWED_DB_HOST+++[]
86+
endif::add-copy-button-to-env-var[]
87+
ifndef::add-copy-button-to-env-var[]
88+
Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ALLOWED_DB_HOST+++`
89+
endif::add-copy-button-to-env-var[]
90+
--
91+
|string
92+
|
93+
1094
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-jdbc]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc[`quarkus.datasource.jdbc`]##
1195
ifdef::add-copy-button-to-config-props[]
1296
config_property_copy_button:+++quarkus.datasource.jdbc+++[]

‎_generated-doc/main/config/quarkus-agroal_quarkus.datasource.adoc‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,90 @@ h|[.header-title]##Configuration property##
77
h|Type
88
h|Default
99

10+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-enabled[`quarkus.datasource.dev-ui.enabled`]##
11+
ifdef::add-copy-button-to-config-props[]
12+
config_property_copy_button:+++quarkus.datasource.dev-ui.enabled+++[]
13+
endif::add-copy-button-to-config-props[]
14+
15+
16+
[.description]
17+
--
18+
Activate or disable the dev ui page.
19+
20+
21+
ifdef::add-copy-button-to-env-var[]
22+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ENABLED+++[]
23+
endif::add-copy-button-to-env-var[]
24+
ifndef::add-copy-button-to-env-var[]
25+
Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ENABLED+++`
26+
endif::add-copy-button-to-env-var[]
27+
--
28+
|boolean
29+
|`true`
30+
31+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-allow-sql]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-allow-sql[`quarkus.datasource.dev-ui.allow-sql`]##
32+
ifdef::add-copy-button-to-config-props[]
33+
config_property_copy_button:+++quarkus.datasource.dev-ui.allow-sql+++[]
34+
endif::add-copy-button-to-config-props[]
35+
36+
37+
[.description]
38+
--
39+
Allow sql queries in the Dev UI page
40+
41+
42+
ifdef::add-copy-button-to-env-var[]
43+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ALLOW_SQL+++[]
44+
endif::add-copy-button-to-env-var[]
45+
ifndef::add-copy-button-to-env-var[]
46+
Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ALLOW_SQL+++`
47+
endif::add-copy-button-to-env-var[]
48+
--
49+
|boolean
50+
|`false`
51+
52+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-append-to-default-select]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-append-to-default-select[`quarkus.datasource.dev-ui.append-to-default-select`]##
53+
ifdef::add-copy-button-to-config-props[]
54+
config_property_copy_button:+++quarkus.datasource.dev-ui.append-to-default-select+++[]
55+
endif::add-copy-button-to-config-props[]
56+
57+
58+
[.description]
59+
--
60+
Append this to the select done to fetch the table values. eg: LIMIT 100 or TOP 100
61+
62+
63+
ifdef::add-copy-button-to-env-var[]
64+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_APPEND_TO_DEFAULT_SELECT+++[]
65+
endif::add-copy-button-to-env-var[]
66+
ifndef::add-copy-button-to-env-var[]
67+
Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_APPEND_TO_DEFAULT_SELECT+++`
68+
endif::add-copy-button-to-env-var[]
69+
--
70+
|string
71+
|
72+
73+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-allowed-db-host]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-allowed-db-host[`quarkus.datasource.dev-ui.allowed-db-host`]##
74+
ifdef::add-copy-button-to-config-props[]
75+
config_property_copy_button:+++quarkus.datasource.dev-ui.allowed-db-host+++[]
76+
endif::add-copy-button-to-config-props[]
77+
78+
79+
[.description]
80+
--
81+
Allowed database host. By default only localhost is allowed. Any provided host here will also be allowed
82+
83+
84+
ifdef::add-copy-button-to-env-var[]
85+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ALLOWED_DB_HOST+++[]
86+
endif::add-copy-button-to-env-var[]
87+
ifndef::add-copy-button-to-env-var[]
88+
Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ALLOWED_DB_HOST+++`
89+
endif::add-copy-button-to-env-var[]
90+
--
91+
|string
92+
|
93+
1094
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-jdbc]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc[`quarkus.datasource.jdbc`]##
1195
ifdef::add-copy-button-to-config-props[]
1296
config_property_copy_button:+++quarkus.datasource.jdbc+++[]

‎_generated-doc/main/config/quarkus-all-config.adoc‎

Lines changed: 86 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,90 @@ h|[.extension-name]##Agroal - Database connection pool##
77
h|Type
88
h|Default
99

10+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-enabled[`quarkus.datasource.dev-ui.enabled`]##
11+
ifdef::add-copy-button-to-config-props[]
12+
config_property_copy_button:+++quarkus.datasource.dev-ui.enabled+++[]
13+
endif::add-copy-button-to-config-props[]
14+
15+
16+
[.description]
17+
--
18+
Activate or disable the dev ui page.
19+
20+
21+
ifdef::add-copy-button-to-env-var[]
22+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ENABLED+++[]
23+
endif::add-copy-button-to-env-var[]
24+
ifndef::add-copy-button-to-env-var[]
25+
Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ENABLED+++`
26+
endif::add-copy-button-to-env-var[]
27+
--
28+
|boolean
29+
|`true`
30+
31+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-allow-sql]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-allow-sql[`quarkus.datasource.dev-ui.allow-sql`]##
32+
ifdef::add-copy-button-to-config-props[]
33+
config_property_copy_button:+++quarkus.datasource.dev-ui.allow-sql+++[]
34+
endif::add-copy-button-to-config-props[]
35+
36+
37+
[.description]
38+
--
39+
Allow sql queries in the Dev UI page
40+
41+
42+
ifdef::add-copy-button-to-env-var[]
43+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ALLOW_SQL+++[]
44+
endif::add-copy-button-to-env-var[]
45+
ifndef::add-copy-button-to-env-var[]
46+
Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ALLOW_SQL+++`
47+
endif::add-copy-button-to-env-var[]
48+
--
49+
|boolean
50+
|`false`
51+
52+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-append-to-default-select]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-append-to-default-select[`quarkus.datasource.dev-ui.append-to-default-select`]##
53+
ifdef::add-copy-button-to-config-props[]
54+
config_property_copy_button:+++quarkus.datasource.dev-ui.append-to-default-select+++[]
55+
endif::add-copy-button-to-config-props[]
56+
57+
58+
[.description]
59+
--
60+
Append this to the select done to fetch the table values. eg: LIMIT 100 or TOP 100
61+
62+
63+
ifdef::add-copy-button-to-env-var[]
64+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_APPEND_TO_DEFAULT_SELECT+++[]
65+
endif::add-copy-button-to-env-var[]
66+
ifndef::add-copy-button-to-env-var[]
67+
Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_APPEND_TO_DEFAULT_SELECT+++`
68+
endif::add-copy-button-to-env-var[]
69+
--
70+
|string
71+
|
72+
73+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-allowed-db-host]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-allowed-db-host[`quarkus.datasource.dev-ui.allowed-db-host`]##
74+
ifdef::add-copy-button-to-config-props[]
75+
config_property_copy_button:+++quarkus.datasource.dev-ui.allowed-db-host+++[]
76+
endif::add-copy-button-to-config-props[]
77+
78+
79+
[.description]
80+
--
81+
Allowed database host. By default only localhost is allowed. Any provided host here will also be allowed
82+
83+
84+
ifdef::add-copy-button-to-env-var[]
85+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ALLOWED_DB_HOST+++[]
86+
endif::add-copy-button-to-env-var[]
87+
ifndef::add-copy-button-to-env-var[]
88+
Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ALLOWED_DB_HOST+++`
89+
endif::add-copy-button-to-env-var[]
90+
--
91+
|string
92+
|
93+
1094
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-jdbc]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc[`quarkus.datasource.jdbc`]##
1195
ifdef::add-copy-button-to-config-props[]
1296
config_property_copy_button:+++quarkus.datasource.jdbc+++[]
@@ -12116,7 +12200,7 @@ endif::add-copy-button-to-config-props[]
1211612200
--
1211712201
Require that all registered HTTP authentication mechanisms must complete the authentication.
1211812202

12119-
Typically, this property has to be true when the credentials are carried over mTLS, when both mTLS and another authentication, for example, OIDC bearer token authentication, must succeed. In such cases, `SecurityIdentity` created by the first mechanism, mTLS, can be injected, identities created by other mechanisms will be available on `SecurityIdentity`. The identities can be retrieved using utility method as in the example below:
12203+
Typically, this property has to be true when the credentials are carried over mTLS, when both mTLS and another authentication, for example, OIDC bearer token authentication, must succeed. In such cases, `SecurityIdentity` created by the first mechanism, mTLS, can be injected, identities created by other mechanisms will be available on `SecurityIdentity`. The mTLS mechanism is always the first mechanism, because its priority is elevated when inclusive authentication is enabled. The identities can be retrieved using utility method as in the example below:
1212012204

1212112205
```
1212212206
`io.quarkus.vertx.http.runtime.security.HttpSecurityUtils.getSecurityIdentities(securityIdentity)`
@@ -82297,7 +82381,7 @@ endif::add-copy-button-to-config-props[]
8229782381

8229882382
[.description]
8229982383
--
82300-
Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the `@RegisterProvider` annotation.
82384+
Fully-qualified provider classnames to include in the client. The equivalent of the `@RegisterProvider` annotation.
8230182385

8230282386
Can be overwritten by client-specific settings.
8230382387

‎_generated-doc/main/config/quarkus-rest-client-config.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ endif::add-copy-button-to-config-props[]
414414

415415
[.description]
416416
--
417-
Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the `@RegisterProvider` annotation.
417+
Fully-qualified provider classnames to include in the client. The equivalent of the `@RegisterProvider` annotation.
418418

419419
Can be overwritten by client-specific settings.
420420

‎_generated-doc/main/config/quarkus-rest-client-config_quarkus.rest-client.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ endif::add-copy-button-to-config-props[]
414414

415415
[.description]
416416
--
417-
Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the `@RegisterProvider` annotation.
417+
Fully-qualified provider classnames to include in the client. The equivalent of the `@RegisterProvider` annotation.
418418

419419
Can be overwritten by client-specific settings.
420420

‎_generated-doc/main/config/quarkus-vertx-http_quarkus.http.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ endif::add-copy-button-to-config-props[]
122122
--
123123
Require that all registered HTTP authentication mechanisms must complete the authentication.
124124

125-
Typically, this property has to be true when the credentials are carried over mTLS, when both mTLS and another authentication, for example, OIDC bearer token authentication, must succeed. In such cases, `SecurityIdentity` created by the first mechanism, mTLS, can be injected, identities created by other mechanisms will be available on `SecurityIdentity`. The identities can be retrieved using utility method as in the example below:
125+
Typically, this property has to be true when the credentials are carried over mTLS, when both mTLS and another authentication, for example, OIDC bearer token authentication, must succeed. In such cases, `SecurityIdentity` created by the first mechanism, mTLS, can be injected, identities created by other mechanisms will be available on `SecurityIdentity`. The mTLS mechanism is always the first mechanism, because its priority is elevated when inclusive authentication is enabled. The identities can be retrieved using utility method as in the example below:
126126

127127
```
128128
`io.quarkus.vertx.http.runtime.security.HttpSecurityUtils.getSecurityIdentities(securityIdentity)`

‎_versions/main/guides/security-authentication-mechanisms.adoc‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,11 @@ quarkus.http.auth.inclusive=true
602602
If the authentication is inclusive then `SecurityIdentity` created by the first authentication mechanism can be
603603
injected into the application code.
604604
For example, if both <<mutual-tls>> and basic authentication mechanism authentications are required,
605-
the <<mutual-tls>> authentication mechanism will create `SecurityIdentity` first.
605+
the <<mutual-tls>> mechanism will create `SecurityIdentity` first.
606+
607+
NOTE: The <<mutual-tls>> mechanism has the highest priority when inclusive authentication is enabled, to ensure
608+
that an injected `SecurityIdentity` always represents <<mutual-tls>> and can be used to get access to `SecurityIdentity`
609+
identities provided by other authentication mechanisms.
606610

607611
Additional `SecurityIdentity` instances can be accessed as a `quarkus.security.identities` attribute on the first
608612
`SecurityIdentity`, however, accessing these extra identities directly may not be necessary, for example,

0 commit comments

Comments
 (0)