Skip to content

Commit 4f7f170

Browse files
committed
Sync documentation of main branch
1 parent e0eeaec commit 4f7f170

21 files changed

+49
-49
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11589,7 +11589,7 @@ Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++`
1158911589
endif::add-copy-button-to-env-var[]
1159011590
--
1159111591
|string
11592-
|`quay.io/keycloak/keycloak:25.0.6`
11592+
|`quay.io/keycloak/keycloak:26.0.7`
1159311593

1159411594
a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image[`quarkus.keycloak.devservices.keycloak-x-image`]##
1159511595
ifdef::add-copy-button-to-config-props[]
@@ -15564,7 +15564,7 @@ endif::add-copy-button-to-config-props[]
1556415564

1556515565
[.description]
1556615566
--
15567-
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.
15567+
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.
1556815568

1556915569

1557015570
ifdef::add-copy-button-to-env-var[]
@@ -15585,7 +15585,7 @@ endif::add-copy-button-to-config-props[]
1558515585

1558615586
[.description]
1558715587
--
15588-
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.
15588+
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.
1558915589

1559015590

1559115591
ifdef::add-copy-button-to-env-var[]
@@ -17289,7 +17289,7 @@ endif::add-copy-button-to-config-props[]
1728917289

1729017290
[.description]
1729117291
--
17292-
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.
17292+
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.
1729317293

1729417294

1729517295
ifdef::add-copy-button-to-env-var[]
@@ -17310,7 +17310,7 @@ endif::add-copy-button-to-config-props[]
1731017310

1731117311
[.description]
1731217312
--
17313-
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.
17313+
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.
1731417314

1731517315

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

_generated-doc/main/config/quarkus-devservices-keycloak.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++`
4747
endif::add-copy-button-to-env-var[]
4848
--
4949
|string
50-
|`quay.io/keycloak/keycloak:25.0.6`
50+
|`quay.io/keycloak/keycloak:26.0.7`
5151

5252
a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image[`quarkus.keycloak.devservices.keycloak-x-image`]##
5353
ifdef::add-copy-button-to-config-props[]

_generated-doc/main/config/quarkus-devservices-keycloak_quarkus.keycloak.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++`
4747
endif::add-copy-button-to-env-var[]
4848
--
4949
|string
50-
|`quay.io/keycloak/keycloak:25.0.6`
50+
|`quay.io/keycloak/keycloak:26.0.7`
5151

5252
a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image[`quarkus.keycloak.devservices.keycloak-x-image`]##
5353
ifdef::add-copy-button-to-config-props[]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3486,7 +3486,7 @@ endif::add-copy-button-to-config-props[]
34863486

34873487
[.description]
34883488
--
3489-
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.
3489+
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.
34903490

34913491

34923492
ifdef::add-copy-button-to-env-var[]
@@ -3507,7 +3507,7 @@ endif::add-copy-button-to-config-props[]
35073507

35083508
[.description]
35093509
--
3510-
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.
3510+
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.
35113511

35123512

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1455,7 +1455,7 @@ endif::add-copy-button-to-config-props[]
14551455

14561456
[.description]
14571457
--
1458-
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.
1458+
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.
14591459

14601460

14611461
ifdef::add-copy-button-to-env-var[]
@@ -1476,7 +1476,7 @@ endif::add-copy-button-to-config-props[]
14761476

14771477
[.description]
14781478
--
1479-
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.
1479+
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.
14801480

14811481

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

_versions/main/guides/_attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
:infinispan-protostream-version: ${infinispan.protostream.version}
1919
:logstash-image: docker.io/elastic/logstash:8.15.0
2020
:kibana-image: docker.io/elastic/kibana:8.15.0
21-
:keycloak-docker-image: quay.io/keycloak/keycloak:25.0.6
21+
:keycloak-docker-image: quay.io/keycloak/keycloak:26.0.7
2222
:jandex-version: 3.2.3
2323
:jandex-gradle-plugin-version: 1.0.0
2424
:kotlin-version: 2.0.21

_versions/main/guides/deploying-to-openshift.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ You can provide the arguments that will be used by the Kubernetes Job via the pr
417417

418418
Finally, the Kubernetes job will be launched every time that is installed in OpenShift. You can know more about how to run Kubernetes jobs in this https://kubernetes.io/docs/concepts/workloads/controllers/job/#running-an-example-job[link].
419419

420-
You can configure the rest of the Kubernetes Job configuration using the properties under `quarkus.openshift.job.xxx` (see xref:deploying-to-openshift#quarkus-kubernetes_quarkus-openshift-job-parallelism[link]).
420+
You can configure the rest of the Kubernetes Job configuration using the properties under `quarkus.openshift.job.xxx` (see xref:deploying-to-openshift.adoc#quarkus-kubernetes_quarkus-openshift-job-parallelism[link]).
421421

422422
===== Generating CronJob resources
423423

_versions/main/guides/extension-maturity-matrix.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ It's completely OK to publish a first version of an extension that doesn't handl
2727
Also note that this list only includes the technical features of your extension.
2828
You might also want to think about how you share your extension, and how it presents itself to the world.
2929
The link:https://hub.quarkiverse.io/checklistfornewprojects/[new extension checklist] on the Quarkiverse Hub has a useful list of ways extensions can participate in the ecosystem.
30-
It's also a good idea to spend some time on the metadata in the xref:extension-metadata#quarkus-extension-yaml[`quarkus-extension.yaml` file], which is used by Quarkus tooling.
30+
It's also a good idea to spend some time on the metadata in the xref:extension-metadata.adoc#quarkus-extension-yaml[`quarkus-extension.yaml` file], which is used by Quarkus tooling.
3131

3232
Here are some pointers on how to achieve those capabilities.
3333

@@ -66,7 +66,7 @@ The Writing Extensions guide has more guidance on xref:writing-extensions.adoc#h
6666
=== CDI Beans
6767

6868
Quarkus extensions should aim to xref:writing-extensions.adoc#expose-your-components-via-cdi[expose components via CDI], so that they can be consumed in a frictionless way by user applications.
69-
Having everything injectable as CDI beans also helps testing, especially xref:getting-started-testing#mock-support[mocking].
69+
Having everything injectable as CDI beans also helps testing, especially xref:getting-started-testing.adoc#mock-support[mocking].
7070

7171
=== Dev Service
7272

@@ -95,7 +95,7 @@ A good starting point is usually to use
9595
Although providing new, joyful, ways to do things is good,
9696
it's important to not break the normal patterns that users may be familiar with.
9797

98-
For some inspiration in this area, have a look at xref:logging#simplified-logging[simplified logging], xref:hibernate-orm-panache.adoc[simplified Hibernate ORM with Panache], the xref:rest-client.adoc#query-parameters[`@RestQuery` annotation], or the way Quarkus allows test containers to be used xref:getting-started-dev-services.adoc[without any configuration].
98+
For some inspiration in this area, have a look at xref:logging.adoc#simplified-logging[simplified logging], xref:hibernate-orm-panache.adoc[simplified Hibernate ORM with Panache], the xref:rest-client.adoc#query-parameters[`@RestQuery` annotation], or the way Quarkus allows test containers to be used xref:getting-started-dev-services.adoc[without any configuration].
9999

100100
=== Codestart application template
101101

@@ -124,7 +124,7 @@ For a case study of how to eliminate reflection and what the performance benefit
124124
=== Virtual thread support
125125

126126
Not every library is suitable for using with virtual threads, out of the box.
127-
xref:virtual-threads#why-not["Why not virtual threads everywhere?"] explains why.
127+
xref:virtual-threads.adoc#why-not["Why not virtual threads everywhere?"] explains why.
128128

129129
To get your library working properly with virtual threads, you should make sure the library is not pinning the carrier thread.
130130
Quarkus has xref:virtual-threads.adoc#testing-virtual-thread-applications[test helpers to do these checks in an automated way].
@@ -157,7 +157,7 @@ Avoid using errors and warnings for conditions that will not affect normal opera
157157

158158
=== Define health endpoints
159159

160-
Extensions may wish to xref:writing-extensions#extension-defined-endpoints[define library-specific endpoints] for health criteria which are specific to that extension. To add a new endpoint, extensions should produce a `NonApplicationRootPathBuildItem`.
160+
Extensions may wish to xref:writing-extensions.adoc#extension-defined-endpoints[define library-specific endpoints] for health criteria which are specific to that extension. To add a new endpoint, extensions should produce a `NonApplicationRootPathBuildItem`.
161161

162162
=== Tracing context
163163

_versions/main/guides/getting-started-testing.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1224,20 +1224,20 @@ public @interface WithRepeatableTestResource {
12241224
}
12251225
----
12261226

1227-
=== Usage of `@WithTestResources`
1227+
=== Usage of `@WithTestResource`
12281228

1229-
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.
1230-
`@WithTestResources` has a `scope` property that takes a `TestResourceScope` enum value:
1229+
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.
1230+
`@WithTestResource` has a `scope` property that takes a `TestResourceScope` enum value:
12311231

12321232
- `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.
12331233
- `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.
1234-
- `TestResourceScope.GLOBAL`: Test resources apply to all tests in the testsuite
1234+
- `TestResourceScope.GLOBAL`: Test resources apply to all tests in the test suite
12351235

12361236
Quarkus needs to restart if one of the following is true:
12371237

1238-
- At least one the existing test resources is restricted to the test class
1239-
- At least one the next test resources is restricted to the test class
1240-
- Different {@code MATCHING_RESOURCE} scoped test resources are being used
1238+
- At least one of the test resources of the current test is restricted to the test class
1239+
- At least one of the test resources of the next test is restricted to the test class
1240+
- Different `MATCHING_RESOURCES` scoped test resources are being used
12411241

12421242
== Hang Detection
12431243

_versions/main/guides/security-keycloak-authorization.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ docker run --name keycloak \
306306
start --hostname-strict=false --https-key-store-file=/etc/keycloak-keystore.jks <2>
307307
----
308308

309-
<1> For `keycloak.version`, ensure the version is `25.0.6` or later.
309+
<1> For `keycloak.version`, ensure the version is `26.0.7` or later.
310310
<2> For Keycloak keystore, use the `keycloak-keystore.jks` file located at https://github.com/quarkusio/quarkus-quickstarts/blob/main/security-keycloak-authorization-quickstart/config/keycloak-keystore.jks[quarkus-quickstarts/security-keycloak-authorization-quickstart/config].
311311

312312

0 commit comments

Comments
 (0)