Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Dec 7, 2023
1 parent 88cc44b commit 13e06e4
Show file tree
Hide file tree
Showing 11 changed files with 172 additions and 73 deletions.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

42 changes: 31 additions & 11 deletions _generated-doc/main/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6406,7 +6406,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus.http.ssl.cli

[.description]
--
Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED
Configures the engine to require/request client authentication. `NONE, REQUEST, REQUIRED`.

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`.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_SSL_CLIENT_AUTH+++[]
Expand Down Expand Up @@ -6443,15 +6445,15 @@ a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus.http.non-app
--
A common root path for non-application endpoints. Various extension-provided endpoints such as metrics, health,
and openapi are deployed under this path by default.

<p>
* Relative path (Default, `q`) ->
Non-application endpoints will be served from
`${quarkus.http.root-path}/${quarkus.http.non-application-root-path}`.
* Absolute path (`/q`) ->
Non-application endpoints will be served from the specified path.
* `${quarkus.http.root-path}` -> Setting this path to the same value as HTTP root path disables
this root path. All extension-provided endpoints will be served from `${quarkus.http.root-path}`.

<p>
If the management interface is enabled, the root path for the endpoints exposed on the management interface
is configured using the `quarkus.management.root-path` property instead of this property.

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

[.description]
--
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`.
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`.

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

[.description]
--
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.
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.

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

[.description]
--
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.
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.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_HOST+++[]
Expand Down Expand Up @@ -6954,6 +6964,8 @@ a| [[quarkus-vertx-http_quarkus.http.insecure-requests]]`link:#quarkus-vertx-htt
--
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.

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`.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_INSECURE_REQUESTS+++[]
endif::add-copy-button-to-env-var[]
Expand All @@ -6962,15 +6974,17 @@ Environment variable: `+++QUARKUS_HTTP_INSECURE_REQUESTS+++`
endif::add-copy-button-to-env-var[]
-- a|
`enabled`, `redirect`, `disabled`
|`enabled`
|


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


[.description]
--
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.
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.

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

[.description]
--
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.
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.

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

[.description]
--
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
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

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

[.description]
--
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.
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.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_RECORD_REQUEST_START_TIME+++[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-http-http-build-time-config_qua

[.description]
--
Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED
Configures the engine to require/request client authentication. `NONE, REQUEST, REQUIRED`.

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`.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_SSL_CLIENT_AUTH+++[]
Expand Down Expand Up @@ -137,15 +139,15 @@ a|icon:lock[title=Fixed at build time] [[quarkus-http-http-build-time-config_qua
--
A common root path for non-application endpoints. Various extension-provided endpoints such as metrics, health,
and openapi are deployed under this path by default.

<p>
* Relative path (Default, `q`) ->
Non-application endpoints will be served from
`${quarkus.http.root-path}/${quarkus.http.non-application-root-path}`.
* Absolute path (`/q`) ->
Non-application endpoints will be served from the specified path.
* `${quarkus.http.root-path}` -> Setting this path to the same value as HTTP root path disables
this root path. All extension-provided endpoints will be served from `${quarkus.http.root-path}`.
<p>
If the management interface is enabled, the root path for the endpoints exposed on the management interface
is configured using the `quarkus.management.root-path` property instead of this property.

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

[.description]
--
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`.
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`.

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

[.description]
--
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.
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.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_ENABLE_DECOMPRESSION+++[]
Expand Down
26 changes: 20 additions & 6 deletions _generated-doc/main/config/quarkus-http-http-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,11 @@ a| [[quarkus-http-http-configuration_quarkus.http.host]]`link:#quarkus-http-http

[.description]
--
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.
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.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_HOST+++[]
Expand Down Expand Up @@ -413,6 +417,8 @@ a| [[quarkus-http-http-configuration_quarkus.http.insecure-requests]]`link:#quar
--
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.

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`.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_INSECURE_REQUESTS+++[]
endif::add-copy-button-to-env-var[]
Expand All @@ -421,15 +427,17 @@ Environment variable: `+++QUARKUS_HTTP_INSECURE_REQUESTS+++`
endif::add-copy-button-to-env-var[]
-- a|
`enabled`, `redirect`, `disabled`
|`enabled`
|


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


[.description]
--
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.
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.

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

[.description]
--
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.
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.

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

[.description]
--
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
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

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

[.description]
--
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.
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.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_RECORD_REQUEST_START_TIME+++[]
Expand Down
Loading

0 comments on commit 13e06e4

Please sign in to comment.