Skip to content

Commit 9c123fb

Browse files
committed
docs: add optional env variables to readme
1 parent 61384a0 commit 9c123fb

File tree

2 files changed

+24
-9
lines changed

2 files changed

+24
-9
lines changed

.env.development

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
ABOUT_US_URL=
12
ACCESS_TOKEN_COOKIE_NAME=edx-jwt-cookie-header-payload
3+
ACCESSIBILITY_URL=
24
BASE_URL=localhost:8080
5+
CONTACT_URL=
36
CREDENTIALS_BASE_URL=http://localhost:18150
47
CSRF_TOKEN_API_PATH=/csrf/api/v1/token
58
ECOMMERCE_BASE_URL=http://localhost:18130
9+
HONOR_CODE_URL=
610
LANGUAGE_PREFERENCE_COOKIE_NAME=openedx-language-preference
711
LMS_BASE_URL=http://localhost:18000
812
LOGIN_URL=http://localhost:18000/login
@@ -12,21 +16,17 @@ TERMS_OF_SERVICE_URL=null
1216
PRIVACY_POLICY_URL=null
1317
SUPPORT_EMAIL=null
1418
STUDIO_BASE_URL=http://localhost:18010
19+
TRADEMARK_TEXT=
1520
ORDER_HISTORY_URL=localhost:1996/orders
1621
REFRESH_ACCESS_TOKEN_ENDPOINT=http://localhost:18000/login_refresh
1722
SEGMENT_KEY=null
23+
SHOW_LOGO=true
1824
SITE_NAME=Open edX
25+
SUPPORT_CENTER_TEXT=
26+
SUPPORT_CENTER_URL=
1927
USER_INFO_COOKIE_NAME=edx-user-info
28+
LOGO_ALT_TEXT="Open edX Logo"
2029
LOGO_URL=https://edx-cdn.org/v3/default/logo.svg
2130
LOGO_TRADEMARK_URL=https://edx-cdn.org/v3/default/logo-trademark.svg
2231
LOGO_WHITE_URL=https://edx-cdn.org/v3/default/logo-white.svg
2332
FAVICON_URL=https://edx-cdn.org/v3/default/favicon.ico
24-
ACCESSIBILITY_URL=
25-
ABOUT_US_URL=
26-
HONOR_CODE_URL=
27-
CONTACT_URL=
28-
SUPPORT_CENTER_URL=
29-
SUPPORT_CENTER_TEXT=
30-
TRADEMARK_TEXT=
31-
LOGO_ALT_TEXT=
32-
SHOW_LOGO=

README.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,21 @@ This component requires that the following environment variable be set by the co
4343
* ``LMS_BASE_URL`` - The URL of the LMS of your Open edX instance.
4444
* ``LOGO_TRADEMARK_URL`` - This is a URL to a logo for use in the footer. This is a different environment variable than ``LOGO_URL`` (used in frontend-component-header) to accommodate sites that would like to have additional trademark information on a logo in the footer, such as a (tm) or (r) symbol.
4545

46+
Optional Environment Variables
47+
=====================
48+
Apart from the required environment variables, this component also supports the following optional environment variable. These variables add the ability to display
49+
custom legal links in the footer. Optional Environment Variables can also be set by the consuming micro-frontend
50+
51+
* ``ABOUT_US_URL`` - About Us page URL.
52+
* ``ACCESSIBILITY_URL`` - Accessibility page URL.
53+
* ``CONTACT_URL`` - Contact Us page URL.
54+
* ``HONOR_CODE_URL`` - Honor Code page URL.
55+
* ``LOGO_ALT_TEXT`` - Alt text for the logo.
56+
* ``SHOW_LOGO`` - Optionally display the logo.
57+
* ``SUPPORT_CENTER_TEXT`` - Text for the Support Center link i.e. `Help Center`.
58+
* ``SUPPORT_CENTER_URL`` - Support center URL.
59+
* ``TRADEMARK_TEXT`` - Trademark text.
60+
4661
Installation
4762
============
4863

0 commit comments

Comments
 (0)