Skip to content

Commit 6e5d666

Browse files
committed
docs: update readme
1 parent ba401cb commit 6e5d666

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,13 @@ Environment Variables
5151
* ``AUTHN_MINIMAL_HEADER`` - A boolean flag which hides the main menu, user menu, and logged-out
5252
menu items when truthy. This is intended to be used in micro-frontends like
5353
frontend-app-authentication in which these menus are considered distractions from the user's task.
54-
54+
* ``DASHBOARD_URL`` - The URL of the dashboard page. If not set the default ``<LMS_BASE_URL>/dashboard`` is used.
55+
* ``EXTERNAL_ACCOUNT_PROFILE_URL`` - An optional URL to the external profile page. If not set then default
56+
internal profile page ``<ACCOUNT_PROFILE_URL>/u/<username>`` is used.
57+
* ``SHOW_FULLNAME`` - A boolean flag to display ``full name`` of the user in the header.
58+
Defaults to ``false`` and ``username`` is displayed.
59+
* ``SHOW_SETTINGS_LABEL`` - A boolean flag to use `Settings` label instead of `Account` for the Account Settings page.
60+
Defaults to ``false`` and uses the ``Account`` label.
5561
Installation
5662
============
5763

@@ -184,4 +190,4 @@ Please do not report security issues in public. Please email [email protected]
184190
.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-component-header.svg
185191
:target: @edx/frontend-component-header
186192
.. |semantic-release| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
187-
:target: https://github.com/semantic-release/semantic-release
193+
:target: https://github.com/semantic-release/semantic-release

0 commit comments

Comments
 (0)