You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpBuildTimeConfig
Copy file name to clipboardExpand all lines: _generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpConfiguration
Copy file name to clipboardExpand all lines: _generated-doc/main/config/quarkus-all-config.adoc
+31-11
Original file line number
Diff line number
Diff line change
@@ -6406,7 +6406,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus.http.ssl.cli
6406
6406
6407
6407
[.description]
6408
6408
--
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`.
Non-application endpoints will be served from the specified path.
6452
6454
* `${quarkus.http.root-path}` -> Setting this path to the same value as HTTP root path disables
6453
6455
this root path. All extension-provided endpoints will be served from `${quarkus.http.root-path}`.
6454
-
6456
+
<p>
6455
6457
If the management interface is enabled, the root path for the endpoints exposed on the management interface
6456
6458
is configured using the `quarkus.management.root-path` property instead of this property.
6457
6459
@@ -6488,7 +6490,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus.http.enable-
6488
6490
6489
6491
[.description]
6490
6492
--
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`.
@@ -6505,7 +6509,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus.http.enable-
6505
6509
6506
6510
[.description]
6507
6511
--
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.
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.
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.
6956
6966
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`.
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.
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.
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
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.
Copy file name to clipboardExpand all lines: _generated-doc/main/config/quarkus-http-http-build-time-config.adoc
+11-5
Original file line number
Diff line number
Diff line change
@@ -100,7 +100,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-http-http-build-time-config_qua
100
100
101
101
[.description]
102
102
--
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`.
Non-application endpoints will be served from the specified path.
146
148
* `${quarkus.http.root-path}`-> Setting this path to the same value as HTTP root path disables
147
149
this root path. All extension-provided endpoints will be served from `${quarkus.http.root-path}`.
148
-
150
+
<p>
149
151
If the management interface is enabled, the root path for the endpoints exposed on the management interface
150
152
is configured using the `quarkus.management.root-path` property instead of this property.
151
153
@@ -182,7 +184,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-http-http-build-time-config_qua
182
184
183
185
[.description]
184
186
--
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`.
@@ -199,7 +203,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-http-http-build-time-config_qua
199
203
200
204
[.description]
201
205
--
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.
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.
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.
415
419
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`.
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.
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.
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
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.
0 commit comments