Skip to content

Commit 6305cc1

Browse files
author
quarkusbot
committed
Sync web site with Quarkus documentation
1 parent 9c690aa commit 6305cc1

12 files changed

+29
-23
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12562,7 +12562,7 @@ a| [[quarkus-vertx-http_quarkus-http-proxy-allow-forwarded]] [.property-path]##l
1256212562

1256312563
[.description]
1256412564
--
12565-
If this is true and proxy address forwarding is enabled then the standard `Forwarded` header will be used. In case the not standard `X-Forwarded-For` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-x-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.
12565+
If this is true and proxy address forwarding is enabled then the standard `Forwarded` header will be used. In case the not standard `X-Forwarded-For` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-x-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `Forwarded` or `X-Forwarded-++*++` headers from the client.
1256612566

1256712567

1256812568
ifdef::add-copy-button-to-env-var[]
@@ -12579,7 +12579,7 @@ a| [[quarkus-vertx-http_quarkus-http-proxy-allow-x-forwarded]] [.property-path]#
1257912579

1258012580
[.description]
1258112581
--
12582-
If either this or `allow-forwarded` are true and proxy address forwarding is enabled then the not standard `Forwarded` header will be used. In case the standard `Forwarded` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.
12582+
If either this or `allow-forwarded` are true and proxy address forwarding is enabled then the not standard `Forwarded` header will be used. In case the standard `Forwarded` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `Forwarded` or `X-Forwarded-++*++` headers from the client.
1258312583

1258412584

1258512585
ifdef::add-copy-button-to-env-var[]
@@ -13920,7 +13920,7 @@ a| [[quarkus-vertx-http_quarkus-management-proxy-allow-forwarded]] [.property-pa
1392013920

1392113921
[.description]
1392213922
--
13923-
If this is true and proxy address forwarding is enabled then the standard `Forwarded` header will be used. In case the not standard `X-Forwarded-For` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-x-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.
13923+
If this is true and proxy address forwarding is enabled then the standard `Forwarded` header will be used. In case the not standard `X-Forwarded-For` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-x-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `Forwarded` or `X-Forwarded-++*++` headers from the client.
1392413924

1392513925

1392613926
ifdef::add-copy-button-to-env-var[]
@@ -13937,7 +13937,7 @@ a| [[quarkus-vertx-http_quarkus-management-proxy-allow-x-forwarded]] [.property-
1393713937

1393813938
[.description]
1393913939
--
13940-
If either this or `allow-forwarded` are true and proxy address forwarding is enabled then the not standard `Forwarded` header will be used. In case the standard `Forwarded` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.
13940+
If either this or `allow-forwarded` are true and proxy address forwarding is enabled then the not standard `Forwarded` header will be used. In case the standard `Forwarded` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `Forwarded` or `X-Forwarded-++*++` headers from the client.
1394113941

1394213942

1394313943
ifdef::add-copy-button-to-env-var[]

_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2850,7 +2850,7 @@ a| [[quarkus-vertx-http_quarkus-http-proxy-allow-forwarded]] [.property-path]##l
28502850

28512851
[.description]
28522852
--
2853-
If this is true and proxy address forwarding is enabled then the standard `Forwarded` header will be used. In case the not standard `X-Forwarded-For` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-x-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.
2853+
If this is true and proxy address forwarding is enabled then the standard `Forwarded` header will be used. In case the not standard `X-Forwarded-For` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-x-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `Forwarded` or `X-Forwarded-++*++` headers from the client.
28542854

28552855

28562856
ifdef::add-copy-button-to-env-var[]
@@ -2867,7 +2867,7 @@ a| [[quarkus-vertx-http_quarkus-http-proxy-allow-x-forwarded]] [.property-path]#
28672867

28682868
[.description]
28692869
--
2870-
If either this or `allow-forwarded` are true and proxy address forwarding is enabled then the not standard `Forwarded` header will be used. In case the standard `Forwarded` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.
2870+
If either this or `allow-forwarded` are true and proxy address forwarding is enabled then the not standard `Forwarded` header will be used. In case the standard `Forwarded` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `Forwarded` or `X-Forwarded-++*++` headers from the client.
28712871

28722872

28732873
ifdef::add-copy-button-to-env-var[]

_generated-doc/latest/config/quarkus-vertx-http_quarkus.management.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1168,7 +1168,7 @@ a| [[quarkus-vertx-http_quarkus-management-proxy-allow-forwarded]] [.property-pa
11681168

11691169
[.description]
11701170
--
1171-
If this is true and proxy address forwarding is enabled then the standard `Forwarded` header will be used. In case the not standard `X-Forwarded-For` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-x-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.
1171+
If this is true and proxy address forwarding is enabled then the standard `Forwarded` header will be used. In case the not standard `X-Forwarded-For` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-x-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `Forwarded` or `X-Forwarded-++*++` headers from the client.
11721172

11731173

11741174
ifdef::add-copy-button-to-env-var[]
@@ -1185,7 +1185,7 @@ a| [[quarkus-vertx-http_quarkus-management-proxy-allow-x-forwarded]] [.property-
11851185

11861186
[.description]
11871187
--
1188-
If either this or `allow-forwarded` are true and proxy address forwarding is enabled then the not standard `Forwarded` header will be used. In case the standard `Forwarded` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.
1188+
If either this or `allow-forwarded` are true and proxy address forwarding is enabled then the not standard `Forwarded` header will be used. In case the standard `Forwarded` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `Forwarded` or `X-Forwarded-++*++` headers from the client.
11891189

11901190

11911191
ifdef::add-copy-button-to-env-var[]

_guides/_attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Common attributes.
22
// --> No blank lines (it ends the document header)
33
:project-name: Quarkus
4-
:quarkus-version: 3.17.5
4+
:quarkus-version: 3.17.6
55
:quarkus-platform-groupid: io.quarkus.platform
66
// .
77
:maven-version: 3.9.9

_guides/context-propagation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ them to the client as JSON using xref:rest-json.adoc[Jackson or JSON-B]:
135135
// Create a REST client to the Star Wars API
136136
WebClient client = WebClient.create(vertx,
137137
new WebClientOptions()
138-
.setDefaultHost("swapi.dev")
138+
.setDefaultHost("swapi.tech")
139139
.setDefaultPort(443)
140140
.setSsl(true));
141141
// get the list of Star Wars people, with context capture

_guides/getting-started-reactive.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ include::{includes}/prerequisites.adoc[]
3636

3737
NOTE: Verify that Maven is using the Java version you expect.
3838
If you have multiple JDKs installed, make sure Maven is using the expected one.
39-
You can verify which JDK Maven uses by running `mvn --version.`
39+
You can verify which JDK Maven uses by running `mvn --version`.
4040

4141
== Imperative vs. Reactive: a question of threads
4242

_guides/getting-started-testing.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1236,20 +1236,20 @@ public @interface WithRepeatableTestResource {
12361236
}
12371237
----
12381238

1239-
=== Usage of `@WithTestResources`
1239+
=== Usage of `@WithTestResource`
12401240

1241-
While test resources provided by `@QuarkusTestResource` are available either globally or restricted to the annotated test class (`restrictToAnnotatedClass`), the annotation `@WithTestResources` allows to additionally group tests by test resources for execution.
1242-
`@WithTestResources` has a `scope` property that takes a `TestResourceScope` enum value:
1241+
While test resources provided by `@QuarkusTestResource` are available either globally or restricted to the annotated test class (`restrictToAnnotatedClass`), the annotation `@WithTestResource` allows to additionally group tests by test resources for execution.
1242+
`@WithTestResource` has a `scope` property that takes a `TestResourceScope` enum value:
12431243

12441244
- `TestResourceScope.MATCHING_RESOURCES` (default): Quarkus will group tests with the same test resources and run them together. After a group has been executed, all test resources will be stopped, and the next group will be executed.
12451245
- `TestResourceScope.RESTRICTED_TO_CLASS`: The test resource is available only for the annotated test class and will be stopped after the test class has been executed.
1246-
- `TestResourceScope.GLOBAL`: Test resources apply to all tests in the testsuite
1246+
- `TestResourceScope.GLOBAL`: Test resources apply to all tests in the test suite
12471247

12481248
Quarkus needs to restart if one of the following is true:
12491249

1250-
- At least one the existing test resources is restricted to the test class
1251-
- At least one the next test resources is restricted to the test class
1252-
- Different {@code MATCHING_RESOURCE} scoped test resources are being used
1250+
- At least one of the test resources of the current test is restricted to the test class
1251+
- At least one of the test resources of the next test is restricted to the test class
1252+
- Different `MATCHING_RESOURCES` scoped test resources are being used
12531253

12541254
== Hang Detection
12551255

_guides/http-reference.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -554,7 +554,7 @@ quarkus.http.proxy.trusted-proxies=127.0.0.1 <1>
554554
----
555555
<1> Configure trusted proxy with the IP address `127.0.0.1`. Request headers from any other address are going to be ignored.
556556

557-
Both configurations related to standard and non-standard headers can be combined, although the standard headers configuration will have precedence. However, combining them has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-*` headers from the client.
557+
Both configurations related to standard and non-standard headers can be combined, although the standard headers configuration will have precedence. However, combining them has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `Forwarded` or `X-Forwarded-*` headers from the client.
558558

559559
Supported forwarding address headers are:
560560

_guides/maven-tooling.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -595,7 +595,7 @@ Uber-Jar's final name is configurable via a Maven's build settings `finalName` o
595595

596596
==== Uber-Jar file name suffix
597597

598-
By default the generated uber JAR file name will have the `-runner` suffix, unless it was overridden by configuring a custom one with `quarkus.package.runner-suffix` configuration option.
598+
By default the generated uber JAR file name will have the `-runner` suffix, unless it was overridden by configuring a custom one with `quarkus.package.jar.runner-suffix` configuration option.
599599
If the runner suffix is not desired, it can be disabled by setting `quarkus.package.jar.add-runner-suffix` configuration option to `false`, in which case the uber JAR will replace the original JAR
600600
file generated by `maven-jar-plugin` for the application module.
601601

_guides/mongodb-panache.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ List<String> namesButEmmanuels = persons
242242
.collect(Collectors.toList());
243243
----
244244

245-
NOTE: A `persistOrUpdate()` method exist that persist or update an entity in the database, it uses the __upsert__ capability of MongoDB to do it in a single query.
245+
NOTE: A `persistOrUpdate()` method persists or updates an entity in the database, it uses the __upsert__ capability of MongoDB to do it in a single query.
246246

247247
=== Adding entity methods
248248

@@ -410,7 +410,7 @@ List<String> namesButEmmanuels = persons
410410
.collect(Collectors.toList());
411411
----
412412

413-
NOTE: A `persistOrUpdate()` method exist that persist or update an entity in the database, it uses the __upsert__ capability of MongoDB to do it in a single query.
413+
NOTE: A `persistOrUpdate()` method persists or updates an entity in the database, it uses the __upsert__ capability of MongoDB to do it in a single query.
414414

415415
NOTE: The rest of the documentation show usages based on the active record pattern only,
416416
but keep in mind that they can be performed with the repository pattern as well.

0 commit comments

Comments
 (0)