Sync documentation of main branch

actions-user · actions-user · commit e7135941ce0a · 2025-10-31T01:59:40.000Z
diff --git a/_generated-doc/main/config/quarkus-all-config.adoc b/_generated-doc/main/config/quarkus-all-config.adoc
@@ -21957,7 +21957,7 @@ endif::add-copy-button-to-config-props[]
 
 [.description]
 --
-If the properties are stored in plain text. If this is false (the default) then it is expected that the passwords are of the form HEX( MD5( username ":" realm ":" password ) )
+If the passwords are stored in the property file as plain text, e.g. `quarkus.security.users.embedded.users.alice=AlicesSecretPassword`. If this is false (the default) then it is expected that passwords are hashed as per the `algorithm` config property.
 
 
 ifdef::add-copy-button-to-env-var[]
@@ -21978,9 +21978,9 @@ endif::add-copy-button-to-config-props[]
 
 [.description]
 --
-Determine which algorithm to use.
+The algorithm with which user password is hashed. The library expects a password prepended with the username and the realm, in the form ALG( username ":" realm ":" password ) in hexadecimal format.
 
-This property is ignored if `plainText` is true.
+For example, on a Unix-like system we can produce the expected hash for Alice logging in to the Quarkus realm with password AlicesSecretPassword using `echo -n "alice:Quarkus:AlicesSecretPassword" ++\|++ sha512sum`, and thus set `quarkus.security.users.embedded.users.alice=c8131...4546` (full hash output abbreviated here). This property is ignored if `plainText` is true.
 
 
 ifdef::add-copy-button-to-env-var[]
@@ -21991,7 +21991,7 @@ Environment variable: `+++QUARKUS_SECURITY_USERS_EMBEDDED_ALGORITHM+++`
 endif::add-copy-button-to-env-var[]
 --
 a|`digest-md5`, `digest-sha`, `digest-sha-256`, `digest-sha-384`, `digest-sha-512`, `digest-sha-512-256`
-|`+++digest-md5+++`
+|`+++digest-sha-512+++`
 
 a| [[quarkus-elytron-security-properties-file_quarkus-security-users-embedded-users-users]] [.property-path]##link:#quarkus-elytron-security-properties-file_quarkus-security-users-embedded-users-users[`quarkus.security.users.embedded.users."users"`]##
 ifdef::add-copy-button-to-config-props[]
diff --git a/_generated-doc/main/config/quarkus-elytron-security-properties-file.adoc b/_generated-doc/main/config/quarkus-elytron-security-properties-file.adoc
@@ -15,7 +15,7 @@ endif::add-copy-button-to-config-props[]
 
 [.description]
 --
-If the properties are stored in plain text. If this is false (the default) then it is expected that the passwords are of the form HEX( MD5( username ":" realm ":" password ) )
+If the passwords are stored in the property file as plain text, e.g. `quarkus.security.users.embedded.users.alice=AlicesSecretPassword`. If this is false (the default) then it is expected that passwords are hashed as per the `algorithm` config property.
 
 
 ifdef::add-copy-button-to-env-var[]
@@ -36,9 +36,9 @@ endif::add-copy-button-to-config-props[]
 
 [.description]
 --
-Determine which algorithm to use.
+The algorithm with which user password is hashed. The library expects a password prepended with the username and the realm, in the form ALG( username ":" realm ":" password ) in hexadecimal format.
 
-This property is ignored if `plainText` is true.
+For example, on a Unix-like system we can produce the expected hash for Alice logging in to the Quarkus realm with password AlicesSecretPassword using `echo -n "alice:Quarkus:AlicesSecretPassword" ++\|++ sha512sum`, and thus set `quarkus.security.users.embedded.users.alice=c8131...4546` (full hash output abbreviated here). This property is ignored if `plainText` is true.
 
 
 ifdef::add-copy-button-to-env-var[]
@@ -49,7 +49,7 @@ Environment variable: `+++QUARKUS_SECURITY_USERS_EMBEDDED_ALGORITHM+++`
 endif::add-copy-button-to-env-var[]
 --
 a|`digest-md5`, `digest-sha`, `digest-sha-256`, `digest-sha-384`, `digest-sha-512`, `digest-sha-512-256`
-|`+++digest-md5+++`
+|`+++digest-sha-512+++`
 
 a| [[quarkus-elytron-security-properties-file_quarkus-security-users-embedded-users-users]] [.property-path]##link:#quarkus-elytron-security-properties-file_quarkus-security-users-embedded-users-users[`quarkus.security.users.embedded.users."users"`]##
 ifdef::add-copy-button-to-config-props[]
diff --git a/_generated-doc/main/config/quarkus-elytron-security-properties-file_quarkus.security.adoc b/_generated-doc/main/config/quarkus-elytron-security-properties-file_quarkus.security.adoc
@@ -15,7 +15,7 @@ endif::add-copy-button-to-config-props[]
 
 [.description]
 --
-If the properties are stored in plain text. If this is false (the default) then it is expected that the passwords are of the form HEX( MD5( username ":" realm ":" password ) )
+If the passwords are stored in the property file as plain text, e.g. `quarkus.security.users.embedded.users.alice=AlicesSecretPassword`. If this is false (the default) then it is expected that passwords are hashed as per the `algorithm` config property.
 
 
 ifdef::add-copy-button-to-env-var[]
@@ -36,9 +36,9 @@ endif::add-copy-button-to-config-props[]
 
 [.description]
 --
-Determine which algorithm to use.
+The algorithm with which user password is hashed. The library expects a password prepended with the username and the realm, in the form ALG( username ":" realm ":" password ) in hexadecimal format.
 
-This property is ignored if `plainText` is true.
+For example, on a Unix-like system we can produce the expected hash for Alice logging in to the Quarkus realm with password AlicesSecretPassword using `echo -n "alice:Quarkus:AlicesSecretPassword" ++\|++ sha512sum`, and thus set `quarkus.security.users.embedded.users.alice=c8131...4546` (full hash output abbreviated here). This property is ignored if `plainText` is true.
 
 
 ifdef::add-copy-button-to-env-var[]
@@ -49,7 +49,7 @@ Environment variable: `+++QUARKUS_SECURITY_USERS_EMBEDDED_ALGORITHM+++`
 endif::add-copy-button-to-env-var[]
 --
 a|`digest-md5`, `digest-sha`, `digest-sha-256`, `digest-sha-384`, `digest-sha-512`, `digest-sha-512-256`
-|`+++digest-md5+++`
+|`+++digest-sha-512+++`
 
 a| [[quarkus-elytron-security-properties-file_quarkus-security-users-embedded-users-users]] [.property-path]##link:#quarkus-elytron-security-properties-file_quarkus-security-users-embedded-users-users[`quarkus.security.users.embedded.users."users"`]##
 ifdef::add-copy-button-to-config-props[]
diff --git a/_generated-doc/main/infra/quarkus-maven-plugin-goals.adoc b/_generated-doc/main/infra/quarkus-maven-plugin-goals.adoc
@@ -1284,8 +1284,7 @@ a| [[quarkus-maven-plugin-goal-dev-debug]] debug
 [.description]
 --
 If this server should be started in debug mode. The default is to start in debug mode and listen on port 5005. Whether the JVM is suspended waiting for a debugger to be attached, depends on the value of suspend. 
-debug supports the following options:
-
+debug supports the following options: 
 Value Effect 
 false The JVM is not started in debug mode 
 true The JVM is started in debug mode and will be listening on debugHost:debugPort 
@@ -3134,8 +3133,7 @@ a| [[quarkus-maven-plugin-goal-remote-dev-debug]] debug
 [.description]
 --
 If this server should be started in debug mode. The default is to start in debug mode and listen on port 5005. Whether the JVM is suspended waiting for a debugger to be attached, depends on the value of suspend. 
-debug supports the following options:
-
+debug supports the following options: 
 Value Effect 
 false The JVM is not started in debug mode 
 true The JVM is started in debug mode and will be listening on debugHost:debugPort 
@@ -3687,8 +3685,7 @@ a| [[quarkus-maven-plugin-goal-test-debug]] debug
 [.description]
 --
 If this server should be started in debug mode. The default is to start in debug mode and listen on port 5005. Whether the JVM is suspended waiting for a debugger to be attached, depends on the value of suspend. 
-debug supports the following options:
-
+debug supports the following options: 
 Value Effect 
 false The JVM is not started in debug mode 
 true The JVM is started in debug mode and will be listening on debugHost:debugPort 
diff --git a/_versions/main/guides/_includes/devtools/build.adoc b/_versions/main/guides/_includes/devtools/build.adoc
@@ -2,7 +2,8 @@
 .CLI
 ----
 ifdef::build-additional-parameters[]
-quarkus build quarkus deploy openshift
+quarkus build
+quarkus deploy openshift
 endif::[]
 ifndef::build-additional-parameters[]
 quarkus build
diff --git a/_versions/main/guides/compose-dev-services.adoc b/_versions/main/guides/compose-dev-services.adoc
@@ -35,9 +35,9 @@ This integration provides a seamless development experience while giving you ful
 To use Compose Dev Services, you need:
 
 1. A working *local* container environment: https://docs.docker.com/get-started/get-docker/[Docker] or https://podman.io/docs/installation[Podman]
-
-2. Compose tooling such as `docker-compose` or `podman-compose`
-(Note that `docker compose` and `podman compose` commands internally call these binaries) :
+2. The `docker` or `podman` CLI present in the `$PATH`
+3. Compose tooling such as `docker-compose` or `podman-compose`
+(Note that `docker compose` and `podman compose` commands internally call these binaries):
 
 * For Docker: https://docs.docker.com/compose/install/[Installing Docker Compose]
 * For Podman: https://podman-desktop.io/docs/compose/setting-up-compose[Setting up Compose]
diff --git a/_versions/main/guides/extension-registry-user.adoc b/_versions/main/guides/extension-registry-user.adoc
@@ -221,19 +221,55 @@ Applications using a registry client can be configured using environment variabl
 
 `QUARKUS_REGISTRIES` environment variable can be used to specify which registries should be enabled as a comma-separated list of registry IDs.
 For example
-```
+----
 QUARKUS_REGISTRIES=registry.acme.org,registry.quarkus.io
-```
+----
 That alone will be enough to initialize a registry client to pull extension catalogs from two registries using their default configurations.
 
 Certain registry options could be initialized with their specific environment variables. Each such option will have the following environment variable prefix:
-```
+----
 QUARKUS_REGISTRY_<UPPERCASED_AND_UNDERSCORED_REGISTRY_ID>_
-```
+----
 where `<UPPERCASED_AND_UNDERSCORED_REGISTRY_ID>` is a registry ID with each character converted to uppercase and a `.` replaced with `_`. For example, `REGISTRY_ACME_ORG`.
 
-The following options can be configured with this approach:
+Below are examples of various options that can be configured following this approach.
 
-- Repository URL, for example `QUARKUS_REGISTRY_REGISTRY_ACME_ORG_REPO_URL=https://internal.registry.acme.org/maven`
-- Update policy, for example `QUARKUS_REGISTRY_REGISTRY_ACME_ORG_UPDATE_POLICY=always`
-- Offering, for example `QUARKUS_REGISTRY_REGISTRY_ACME_ORG_OFFERING=acme-magic`
+===== Repository URL
+
+`QUARKUS_REGISTRY_<UPPERCASED_AND_UNDERSCORED_REGISTRY_ID>_REPO_URL=<REPO_URL>`
+
+Example:
+----
+QUARKUS_REGISTRY_REGISTRY_ACME_ORG_REPO_URL=https://internal.registry.acme.org/maven
+----
+
+===== Update policy
+
+`QUARKUS_REGISTRY_<UPPERCASED_AND_UNDERSCORED_REGISTRY_ID>_UPDATE_POLICY=<UPDATE_POLICY>`
+
+Example:
+----
+QUARKUS_REGISTRY_REGISTRY_ACME_ORG_UPDATE_POLICY=always
+----
+
+===== Offering
+
+`QUARKUS_REGISTRY_<UPPERCASED_AND_UNDERSCORED_REGISTRY_ID>_OFFERING=<OFFERING>`
+
+Example:
+----
+QUARKUS_REGISTRY_REGISTRY_ACME_ORG_OFFERING=acme-magic
+----
+
+===== Recommend Streams From
+
+Set the oldest acceptable stream value per platform. Streams older than the configured values will be ignored by the client.
+
+`QUARKUS_REGISTRY_<UPPERCASED_AND_UNDERSCORED_REGISTRY_ID>_RECOMMEND_STREAMS_FROM_<UPPERCASED_AND_UNDERSCORED_PLATFORM_KEY>=<STREAM_ID>`
+
+Where `UPPERCASED_AND_UNDERSCORED_PLATFORM_KEY` is a platform key with each character converted to uppercase and a `.` replaced with `_`. For example, `IO_QUARKUS_PLATFORM`.
+
+Example:
+----
+QUARKUS_REGISTRY_REGISTRY_ACME_ORG_RECOMMEND_STREAMS_FROM_IO_QUARKUS_PLATFORM=3.27
+----
