Skip to content

Commit 13e06e4

Browse files
committed
Sync documentation of main branch
1 parent 88cc44b commit 13e06e4

11 files changed

+172
-73
lines changed

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpBuildTimeConfig

+1-1
Large diffs are not rendered by default.

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpConfiguration

+1-1
Large diffs are not rendered by default.

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

+31-11
Original file line numberDiff line numberDiff line change
@@ -6406,7 +6406,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus.http.ssl.cli
64066406

64076407
[.description]
64086408
--
6409-
Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED
6409+
Configures the engine to require/request client authentication. `NONE, REQUEST, REQUIRED`.
6410+
6411+
When set to `REQUIRED`, it's recommended to also set `quarkus.http.insecure-requests=disabled` to disable the plain HTTP port. If `quarkus.http.insecure-requests` is not set, but this parameter is set to `REQUIRED`, then, `quarkus.http.insecure-requests` is automatically set to `disabled`.
64106412

64116413
ifdef::add-copy-button-to-env-var[]
64126414
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_SSL_CLIENT_AUTH+++[]
@@ -6443,15 +6445,15 @@ a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus.http.non-app
64436445
--
64446446
A common root path for non-application endpoints. Various extension-provided endpoints such as metrics, health,
64456447
and openapi are deployed under this path by default.
6446-
6448+
<p>
64476449
* Relative path (Default, `q`) ->
64486450
Non-application endpoints will be served from
64496451
`${quarkus.http.root-path}/${quarkus.http.non-application-root-path}`.
64506452
* Absolute path (`/q`) ->
64516453
Non-application endpoints will be served from the specified path.
64526454
* `${quarkus.http.root-path}` -> Setting this path to the same value as HTTP root path disables
64536455
this root path. All extension-provided endpoints will be served from `${quarkus.http.root-path}`.
6454-
6456+
<p>
64556457
If the management interface is enabled, the root path for the endpoints exposed on the management interface
64566458
is configured using the `quarkus.management.root-path` property instead of this property.
64576459

@@ -6488,7 +6490,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus.http.enable-
64886490

64896491
[.description]
64906492
--
6491-
If enabled then the response body is compressed if the `Content-Type` header is set and the value is a compressed media type as configured via `compress-media-types`. Note that the RESTEasy Reactive and Reactive Routes extensions also make it possible to enable/disable compression declaratively using the annotations `io.quarkus.vertx.http.Compressed` and `io.quarkus.vertx.http.Uncompressed`.
6493+
If enabled then the response body is compressed if the `Content-Type` header is set and the value is a compressed media type as configured via `compress-media-types`.
6494+
6495+
Note that the RESTEasy Reactive and Reactive Routes extensions also make it possible to enable/disable compression declaratively using the annotations `io.quarkus.vertx.http.Compressed` and `io.quarkus.vertx.http.Uncompressed`.
64926496

64936497
ifdef::add-copy-button-to-env-var[]
64946498
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_ENABLE_COMPRESSION+++[]
@@ -6505,7 +6509,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus.http.enable-
65056509

65066510
[.description]
65076511
--
6508-
When enabled, vert.x will decompress the request's body if it's compressed. Note that the compression format (e.g., gzip) must be specified in the Content-Encoding header in the request.
6512+
When enabled, vert.x will decompress the request's body if it's compressed.
6513+
6514+
Note that the compression format (e.g., gzip) must be specified in the Content-Encoding header in the request.
65096515

65106516
ifdef::add-copy-button-to-env-var[]
65116517
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_ENABLE_DECOMPRESSION+++[]
@@ -6850,7 +6856,11 @@ a| [[quarkus-vertx-http_quarkus.http.host]]`link:#quarkus-vertx-http_quarkus.htt
68506856

68516857
[.description]
68526858
--
6853-
The HTTP host In dev/test mode this defaults to localhost, in prod mode this defaults to 0.0.0.0 Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine.
6859+
The HTTP host
6860+
6861+
In dev/test mode this defaults to localhost, in prod mode this defaults to 0.0.0.0
6862+
6863+
Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine.
68546864

68556865
ifdef::add-copy-button-to-env-var[]
68566866
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_HOST+++[]
@@ -6954,6 +6964,8 @@ a| [[quarkus-vertx-http_quarkus.http.insecure-requests]]`link:#quarkus-vertx-htt
69546964
--
69556965
If insecure (i.e. http rather than https) requests are allowed. If this is `enabled` then http works as normal. `redirect` will still open the http port, but all requests will be redirected to the HTTPS port. `disabled` will prevent the HTTP port from opening at all.
69566966

6967+
Default is `enabled` except when client auth is set to `required` (configured using `quarkus.http.ssl.client-auth=required`). In this case, the default is `disabled`.
6968+
69576969
ifdef::add-copy-button-to-env-var[]
69586970
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_INSECURE_REQUESTS+++[]
69596971
endif::add-copy-button-to-env-var[]
@@ -6962,15 +6974,17 @@ Environment variable: `+++QUARKUS_HTTP_INSECURE_REQUESTS+++`
69626974
endif::add-copy-button-to-env-var[]
69636975
-- a|
69646976
`enabled`, `redirect`, `disabled`
6965-
|`enabled`
6977+
|
69666978

69676979

69686980
a| [[quarkus-vertx-http_quarkus.http.http2]]`link:#quarkus-vertx-http_quarkus.http.http2[quarkus.http.http2]`
69696981

69706982

69716983
[.description]
69726984
--
6973-
If this is true (the default) then HTTP/2 will be enabled. Note that for browsers to be able to use it HTTPS must be enabled, and you must be running on JDK11 or above, as JDK8 does not support ALPN.
6985+
If this is true (the default) then HTTP/2 will be enabled.
6986+
6987+
Note that for browsers to be able to use it HTTPS must be enabled, and you must be running on JDK11 or above, as JDK8 does not support ALPN.
69746988

69756989
ifdef::add-copy-button-to-env-var[]
69766990
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_HTTP2+++[]
@@ -7610,7 +7624,9 @@ a| [[quarkus-vertx-http_quarkus.http.io-threads]]`link:#quarkus-vertx-http_quark
76107624

76117625
[.description]
76127626
--
7613-
The number if IO threads used to perform IO. This will be automatically set to a reasonable value based on the number of CPU cores if it is not provided. If this is set to a higher value than the number of Vert.x event loops then it will be capped at the number of event loops. In general this should be controlled by setting quarkus.vertx.event-loops-pool-size, this setting should only be used if you want to limit the number of HTTP io threads to a smaller number than the total number of IO threads.
7627+
The number if IO threads used to perform IO. This will be automatically set to a reasonable value based on the number of CPU cores if it is not provided. If this is set to a higher value than the number of Vert.x event loops then it will be capped at the number of event loops.
7628+
7629+
In general this should be controlled by setting quarkus.vertx.event-loops-pool-size, this setting should only be used if you want to limit the number of HTTP io threads to a smaller number than the total number of IO threads.
76147630

76157631
ifdef::add-copy-button-to-env-var[]
76167632
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_IO_THREADS+++[]
@@ -7984,7 +8000,9 @@ a| [[quarkus-vertx-http_quarkus.http.auth.session.encryption-key]]`link:#quarkus
79848000

79858001
[.description]
79868002
--
7987-
The encryption key that is used to store persistent logins (e.g. for form auth). Logins are stored in a persistent cookie that is encrypted with AES-256 using a key derived from a SHA-256 hash of the key that is provided here. If no key is provided then an in-memory one will be generated, this will change on every restart though so it is not suitable for production environments. This must be more than 16 characters long for security reasons
8003+
The encryption key that is used to store persistent logins (e.g. for form auth). Logins are stored in a persistent cookie that is encrypted with AES-256 using a key derived from a SHA-256 hash of the key that is provided here.
8004+
8005+
If no key is provided then an in-memory one will be generated, this will change on every restart though so it is not suitable for production environments. This must be more than 16 characters long for security reasons
79888006

79898007
ifdef::add-copy-button-to-env-var[]
79908008
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_SESSION_ENCRYPTION_KEY+++[]
@@ -8137,7 +8155,9 @@ a| [[quarkus-vertx-http_quarkus.http.record-request-start-time]]`link:#quarkus-v
81378155

81388156
[.description]
81398157
--
8140-
If this is true then the request start time will be recorded to enable logging of total request time. This has a small performance penalty, so is disabled by default.
8158+
If this is true then the request start time will be recorded to enable logging of total request time.
8159+
8160+
This has a small performance penalty, so is disabled by default.
81418161

81428162
ifdef::add-copy-button-to-env-var[]
81438163
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_RECORD_REQUEST_START_TIME+++[]

_generated-doc/main/config/quarkus-http-http-build-time-config.adoc

+11-5
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-http-http-build-time-config_qua
100100

101101
[.description]
102102
--
103-
Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED
103+
Configures the engine to require/request client authentication. `NONE, REQUEST, REQUIRED`.
104+
105+
When set to `REQUIRED`, it's recommended to also set `quarkus.http.insecure-requests=disabled` to disable the plain HTTP port. If `quarkus.http.insecure-requests` is not set, but this parameter is set to `REQUIRED`, then, `quarkus.http.insecure-requests` is automatically set to `disabled`.
104106

105107
ifdef::add-copy-button-to-env-var[]
106108
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_SSL_CLIENT_AUTH+++[]
@@ -137,15 +139,15 @@ a|icon:lock[title=Fixed at build time] [[quarkus-http-http-build-time-config_qua
137139
--
138140
A common root path for non-application endpoints. Various extension-provided endpoints such as metrics, health,
139141
and openapi are deployed under this path by default.
140-
142+
<p>
141143
* Relative path (Default, `q`) ->
142144
Non-application endpoints will be served from
143145
`${quarkus.http.root-path}/${quarkus.http.non-application-root-path}`.
144146
* Absolute path (`/q`) ->
145147
Non-application endpoints will be served from the specified path.
146148
* `${quarkus.http.root-path}` -> Setting this path to the same value as HTTP root path disables
147149
this root path. All extension-provided endpoints will be served from `${quarkus.http.root-path}`.
148-
150+
<p>
149151
If the management interface is enabled, the root path for the endpoints exposed on the management interface
150152
is configured using the `quarkus.management.root-path` property instead of this property.
151153

@@ -182,7 +184,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-http-http-build-time-config_qua
182184

183185
[.description]
184186
--
185-
If enabled then the response body is compressed if the `Content-Type` header is set and the value is a compressed media type as configured via `compress-media-types`. Note that the RESTEasy Reactive and Reactive Routes extensions also make it possible to enable/disable compression declaratively using the annotations `io.quarkus.vertx.http.Compressed` and `io.quarkus.vertx.http.Uncompressed`.
187+
If enabled then the response body is compressed if the `Content-Type` header is set and the value is a compressed media type as configured via `compress-media-types`.
188+
189+
Note that the RESTEasy Reactive and Reactive Routes extensions also make it possible to enable/disable compression declaratively using the annotations `io.quarkus.vertx.http.Compressed` and `io.quarkus.vertx.http.Uncompressed`.
186190

187191
ifdef::add-copy-button-to-env-var[]
188192
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_ENABLE_COMPRESSION+++[]
@@ -199,7 +203,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-http-http-build-time-config_qua
199203

200204
[.description]
201205
--
202-
When enabled, vert.x will decompress the request's body if it's compressed. Note that the compression format (e.g., gzip) must be specified in the Content-Encoding header in the request.
206+
When enabled, vert.x will decompress the request's body if it's compressed.
207+
208+
Note that the compression format (e.g., gzip) must be specified in the Content-Encoding header in the request.
203209

204210
ifdef::add-copy-button-to-env-var[]
205211
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_ENABLE_DECOMPRESSION+++[]

_generated-doc/main/config/quarkus-http-http-configuration.adoc

+20-6
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,11 @@ a| [[quarkus-http-http-configuration_quarkus.http.host]]`link:#quarkus-http-http
309309

310310
[.description]
311311
--
312-
The HTTP host In dev/test mode this defaults to localhost, in prod mode this defaults to 0.0.0.0 Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine.
312+
The HTTP host
313+
314+
In dev/test mode this defaults to localhost, in prod mode this defaults to 0.0.0.0
315+
316+
Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine.
313317

314318
ifdef::add-copy-button-to-env-var[]
315319
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_HOST+++[]
@@ -413,6 +417,8 @@ a| [[quarkus-http-http-configuration_quarkus.http.insecure-requests]]`link:#quar
413417
--
414418
If insecure (i.e. http rather than https) requests are allowed. If this is `enabled` then http works as normal. `redirect` will still open the http port, but all requests will be redirected to the HTTPS port. `disabled` will prevent the HTTP port from opening at all.
415419

420+
Default is `enabled` except when client auth is set to `required` (configured using `quarkus.http.ssl.client-auth=required`). In this case, the default is `disabled`.
421+
416422
ifdef::add-copy-button-to-env-var[]
417423
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_INSECURE_REQUESTS+++[]
418424
endif::add-copy-button-to-env-var[]
@@ -421,15 +427,17 @@ Environment variable: `+++QUARKUS_HTTP_INSECURE_REQUESTS+++`
421427
endif::add-copy-button-to-env-var[]
422428
-- a|
423429
`enabled`, `redirect`, `disabled`
424-
|`enabled`
430+
|
425431

426432

427433
a| [[quarkus-http-http-configuration_quarkus.http.http2]]`link:#quarkus-http-http-configuration_quarkus.http.http2[quarkus.http.http2]`
428434

429435

430436
[.description]
431437
--
432-
If this is true (the default) then HTTP/2 will be enabled. Note that for browsers to be able to use it HTTPS must be enabled, and you must be running on JDK11 or above, as JDK8 does not support ALPN.
438+
If this is true (the default) then HTTP/2 will be enabled.
439+
440+
Note that for browsers to be able to use it HTTPS must be enabled, and you must be running on JDK11 or above, as JDK8 does not support ALPN.
433441

434442
ifdef::add-copy-button-to-env-var[]
435443
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_HTTP2+++[]
@@ -1069,7 +1077,9 @@ a| [[quarkus-http-http-configuration_quarkus.http.io-threads]]`link:#quarkus-htt
10691077

10701078
[.description]
10711079
--
1072-
The number if IO threads used to perform IO. This will be automatically set to a reasonable value based on the number of CPU cores if it is not provided. If this is set to a higher value than the number of Vert.x event loops then it will be capped at the number of event loops. In general this should be controlled by setting quarkus.vertx.event-loops-pool-size, this setting should only be used if you want to limit the number of HTTP io threads to a smaller number than the total number of IO threads.
1080+
The number if IO threads used to perform IO. This will be automatically set to a reasonable value based on the number of CPU cores if it is not provided. If this is set to a higher value than the number of Vert.x event loops then it will be capped at the number of event loops.
1081+
1082+
In general this should be controlled by setting quarkus.vertx.event-loops-pool-size, this setting should only be used if you want to limit the number of HTTP io threads to a smaller number than the total number of IO threads.
10731083

10741084
ifdef::add-copy-button-to-env-var[]
10751085
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_IO_THREADS+++[]
@@ -1443,7 +1453,9 @@ a| [[quarkus-http-http-configuration_quarkus.http.auth.session.encryption-key]]`
14431453

14441454
[.description]
14451455
--
1446-
The encryption key that is used to store persistent logins (e.g. for form auth). Logins are stored in a persistent cookie that is encrypted with AES-256 using a key derived from a SHA-256 hash of the key that is provided here. If no key is provided then an in-memory one will be generated, this will change on every restart though so it is not suitable for production environments. This must be more than 16 characters long for security reasons
1456+
The encryption key that is used to store persistent logins (e.g. for form auth). Logins are stored in a persistent cookie that is encrypted with AES-256 using a key derived from a SHA-256 hash of the key that is provided here.
1457+
1458+
If no key is provided then an in-memory one will be generated, this will change on every restart though so it is not suitable for production environments. This must be more than 16 characters long for security reasons
14471459

14481460
ifdef::add-copy-button-to-env-var[]
14491461
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_SESSION_ENCRYPTION_KEY+++[]
@@ -1596,7 +1608,9 @@ a| [[quarkus-http-http-configuration_quarkus.http.record-request-start-time]]`li
15961608

15971609
[.description]
15981610
--
1599-
If this is true then the request start time will be recorded to enable logging of total request time. This has a small performance penalty, so is disabled by default.
1611+
If this is true then the request start time will be recorded to enable logging of total request time.
1612+
1613+
This has a small performance penalty, so is disabled by default.
16001614

16011615
ifdef::add-copy-button-to-env-var[]
16021616
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_RECORD_REQUEST_START_TIME+++[]

0 commit comments

Comments
 (0)