Configuration options
The possible options are stored in a key-value format.
Key | Value |
---|---|
REACT_APP_API_URL | string |
Base API url that will be used when creating RTK Query queries
Key | Value |
---|---|
REACT_APP_AUTH_METHOD | string |
Preferred method of authentication.
Options:
-
cookie
Lets users authenticate by logging into
conda-store
. This is the preferred method of authentication. -
token
Lets users utilize a token generated by
conda-store
to authenticate to the server.
Key | Value |
---|---|
REACT_APP_LOGIN_PAGE_URL | string |
The URL endpoint used for login authentication.
Key | Value |
---|---|
REACT_APP_LOGOUT_PAGE_URL | string |
The URL endpoint used for logout authentication.
Key | Value |
---|---|
REACT_APP_AUTH_TOKEN | null / string |
If using the token
method for authentication, then input the token as a string.
Otherwise, leave blank.
Key | Value |
---|---|
REACT_APP_STYLE_TYPE | string |
Options:
grayscale
green-accent
Key | Value |
---|---|
REACT_APP_SHOW_AUTH_BUTTON | bool |
Options:
-
true
Show the login icon in the top menubar.
-
false
Hide the login icon in the top menubar.
Key | Value |
---|---|
REACT_APP_ROUTER_TYPE | string |
The type of React Router that the UI app will use.
Options:
-
browser
Use the History API to keep track of app routes visited and to sync the current route with the browser URL address bar. For more info, refer to createBrowserRouter in the React Router docs.
-
memory
Manage the history stack in memory instead of using the browser's history (createMemoryRouter). The JupyterLab extension configures the conda-store-ui to use the memory router so that it does not conflict with JupyterLab trying to manage the browser URL and history.
Key | Value |
---|---|
REACT_APP_URL_BASENAME | string |
The URL prefix for the UI app routes, if other than /
. For example, a
Nebari deployment that serves the UI at
/conda-store
should set this variable to /conda-store
. The value of this
variable is passed directly through to React Router's
opts.basename.
Only valid when React Router's "browser" router type is used, otherwise ignored.