From c6bf6c92c19424f50d8b8a9e1d57cb0ea9f18321 Mon Sep 17 00:00:00 2001 From: ahtesham-quraish Date: Wed, 22 Mar 2023 14:22:05 +0500 Subject: [PATCH] docs: add missing configs in readme VAN-1284 --- README.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.rst b/README.rst index 3f0cf3e5..e636389b 100644 --- a/README.rst +++ b/README.rst @@ -104,6 +104,18 @@ The authentication micro-frontend also requires the following additional variabl - Disables the enterprise login from Authn MFE. - ``true`` | ``''`` (empty strings are falsy) + * - ``MFE_CONFIG_API_URL`` + - Link of the API to get runtime mfe configuration variables from the site configuration or django settings. + - ``/api/v1/mfe_config`` | ``''`` (empty strings are falsy) + + * - ``APP_ID`` + - Name of MFE, this will be used by the API to get runtime configurations for the specific micro frontend. For a frontend repo `frontend-app-appName`, use `appName` as APP_ID. + - ``authn`` | ``''`` + + * - ``ENABLE_COOKIE_POLICY_BANNER`` + - Enables support for displaying the cookies acceptance banner. + - ``true`` | ``''`` (empty strings are falsy) + edX-specific Environment Variables ********************************** @@ -121,6 +133,10 @@ Furthermore, there are several edX-specific environment variables that enable in - Enables support for opting in marketing emails that helps us getting user consent for sending marketing emails. - ``true`` | ``''`` (empty strings are falsy) + * - ``SHOW_CONFIGURABLE_EDX_FIELDS`` + - For edX, country and honor code fields are required by default. This flag enables edX specific required fields. + - ``true`` | ``''`` (empty strings are falsy) + For more information see the document: `Micro-frontend applications in Open edX `__.