Skip to content

Commit fc87e78

Browse files
committed
@GitHK review: doc
1 parent 4af7f81 commit fc87e78

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

services/api-server/src/simcore_service_api_server/core/settings.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,10 @@ class WebServerSettings(WebServerBaseSettings, MixinSessionSettings):
4444

4545
WEBSERVER_RPC_NAMESPACE: Annotated[
4646
RPCNamespace,
47-
Field(description="Namespace for the RPC server"),
47+
Field(
48+
description="Namespace for the RPC server."
49+
"IMPORTANT: this is typically `wb-api-server` service variant of the `webserver` image"
50+
),
4851
]
4952

5053
@field_validator("WEBSERVER_SESSION_SECRET_KEY")

services/web/server/src/simcore_service_webserver/application_settings.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,10 @@ class ApplicationSettings(BaseApplicationSettings, MixinLoggingSettings):
157157

158158
WEBSERVER_RPC_NAMESPACE: Annotated[
159159
RPCNamespace | None,
160-
Field(description="Namespace for the RPC server (if any) otherwise None"),
160+
Field(
161+
description="Namespace for the RPC server (if any) otherwise None"
162+
"NOTE that some webserver variants do NOT expose an RPC server e.g. wg-gargage-collector, wg-auth, etc"
163+
),
161164
]
162165

163166
WEBSERVER_SERVER_HOST: Annotated[

0 commit comments

Comments
 (0)