From 6e5d666f363e1ed010d08684e8b24f9a159463ae Mon Sep 17 00:00:00 2001 From: Asad Ali Date: Fri, 29 Mar 2024 16:35:19 +0500 Subject: [PATCH] docs: update readme --- README.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index ab9e4db72f..093856adce 100644 --- a/README.rst +++ b/README.rst @@ -51,7 +51,13 @@ Environment Variables * ``AUTHN_MINIMAL_HEADER`` - A boolean flag which hides the main menu, user menu, and logged-out menu items when truthy. This is intended to be used in micro-frontends like frontend-app-authentication in which these menus are considered distractions from the user's task. - +* ``DASHBOARD_URL`` - The URL of the dashboard page. If not set the default ``/dashboard`` is used. +* ``EXTERNAL_ACCOUNT_PROFILE_URL`` - An optional URL to the external profile page. If not set then default + internal profile page ``/u/`` is used. +* ``SHOW_FULLNAME`` - A boolean flag to display ``full name`` of the user in the header. + Defaults to ``false`` and ``username`` is displayed. +* ``SHOW_SETTINGS_LABEL`` - A boolean flag to use `Settings` label instead of `Account` for the Account Settings page. + Defaults to ``false`` and uses the ``Account`` label. Installation ============ @@ -184,4 +190,4 @@ Please do not report security issues in public. Please email security@openedx.or .. |license| image:: https://img.shields.io/npm/l/@edx/frontend-component-header.svg :target: @edx/frontend-component-header .. |semantic-release| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - :target: https://github.com/semantic-release/semantic-release \ No newline at end of file + :target: https://github.com/semantic-release/semantic-release