diff --git a/fastapi_keycloak_middleware/setup.py b/fastapi_keycloak_middleware/setup.py index 5174b7c..c68912d 100644 --- a/fastapi_keycloak_middleware/setup.py +++ b/fastapi_keycloak_middleware/setup.py @@ -67,9 +67,9 @@ def setup_keycloak_middleware( # pylint: disable=too-many-arguments :param add_swagger_auth: Whether to add OpenID Connect authentication to the OpenAPI schema. Defaults to False. :type add_swagger_auth: bool, optional - :param swagger_openId_base_url: Base URL for the OpenID Connect configuration that will be used - by the Swagger UI. This parameter allows you to specify a different base URL than - the one in keycloak_configuration.url. This is particularly useful in Docker + :param swagger_openId_base_url: Base URL for the OpenID Connect configuration that will be used + by the Swagger UI. This parameter allows you to specify a different base URL than + the one in keycloak_configuration.url. This is particularly useful in Docker container scenarios where the internal and external URLs differ. For example, inside a Docker container network, Keycloak's OpenID configuration @@ -78,13 +78,13 @@ def setup_keycloak_middleware( # pylint: disable=too-many-arguments However, external clients like Swagger UI cannot resolve host.docker.internal. In this case, you would set: - - keycloak_configuration.url: + - keycloak_configuration.url: -- "http://host.docker.internal:8080" (for internal communication) - - swagger_openId_base_url: + - swagger_openId_base_url: -- "http://localhost:8080" (for Swagger UI access) If not specified, defaults to using keycloak_configuration.url. - :type swagger_openId_base_url: str, optional + :type swagger_openId_base_url: str, optional :param swagger_auth_scopes: Scopes to use for the Swagger UI authentication. Defaults to ['openid', 'profile']. :type swagger_auth_scopes: typing.List[str], optional