From c3b7d77e41bc91ed9dd7bf49cf8676b83af7ff46 Mon Sep 17 00:00:00 2001 From: Chris Bono Date: Wed, 12 Feb 2025 10:03:33 -0600 Subject: [PATCH] Update description for servlet server config prop Signed-off-by: Chris Bono --- .../src/main/antora/modules/ROOT/partials/_configprops.adoc | 4 +++- .../META-INF/additional-spring-configuration-metadata.json | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/spring-grpc-docs/src/main/antora/modules/ROOT/partials/_configprops.adoc b/spring-grpc-docs/src/main/antora/modules/ROOT/partials/_configprops.adoc index eb3824a..caa58de 100644 --- a/spring-grpc-docs/src/main/antora/modules/ROOT/partials/_configprops.adoc +++ b/spring-grpc-docs/src/main/antora/modules/ROOT/partials/_configprops.adoc @@ -40,10 +40,12 @@ |spring.grpc.server.observations.enabled | `+++true+++` | Whether to enable Observations on the server. |spring.grpc.server.port | `+++9090+++` | Server port to listen on. When the value is 0, a random available port is selected. The default is 9090. |spring.grpc.server.reflection.enabled | `+++true+++` | Whether to enable Reflection on the gRPC server. +|spring.grpc.server.security.csrf.enabled | `+++false+++` | Whether to enable CSRF protection on gRPC requests. +|spring.grpc.server.servlet.enabled | `+++true+++` | Whether to use a servlet server in a servlet-based web application. When the value is false, a native gRPC server will be forced. |spring.grpc.server.shutdown-grace-period | `+++30s+++` | Maximum time to wait for the server to gracefully shutdown. When the value is negative, the server waits forever. When the value is 0, the server will force shutdown immediately. The default is 30 seconds. |spring.grpc.server.ssl.bundle | | SSL bundle name. |spring.grpc.server.ssl.client-auth | `+++none+++` | Client authentication mode. |spring.grpc.server.ssl.enabled | | Whether to enable SSL support. Enabled automatically if "bundle" is provided unless specified otherwise. |spring.grpc.server.ssl.secure | `+++true+++` | Flag to indicate that client authentication is secure (i.e. certificates are checked). Do not set this to false in production. -|=== +|=== \ No newline at end of file diff --git a/spring-grpc-spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/spring-grpc-spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json index 594003b..ea65bda 100644 --- a/spring-grpc-spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/spring-grpc-spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -26,7 +26,7 @@ { "name": "spring.grpc.server.servlet.enabled", "type": "java.lang.Boolean", - "description": "Whether to use a servlet server in a servlet-based web application (set to false to force a native gRPC server).", + "description": "Whether to use a servlet server in a servlet-based web application. When the value is false, a native gRPC server will be forced.", "defaultValue": true }, {