diff --git a/README.md b/README.md index 829f7121b2..1982fac452 100644 --- a/README.md +++ b/README.md @@ -126,6 +126,7 @@ All other settings can be set using the following convention for naming the envi 1. replace all `.` with `_` 2. convert all characters to upper case +3. prefix with `DSPACE_` e.g. @@ -161,11 +162,11 @@ export DSPACE_HOST=api7.dspace.org export DSPACE_UI_PORT=4200 ``` -The priority works as follows: **environment variable** overrides **variable in `.env` file** overrides external config set by `APP_CONFIG_PATH` overrides **`config.(prod or dev).yml`** +The priority works as follows: **environment variable** overrides **variable in `.env` file** overrides external config set by `DSPACE_APP_CONFIG_PATH` overrides **`config.(prod or dev).yml`** These configuration sources are collected **at run time**, and written to `dist/browser/assets/config.json` for production and `src/app/assets/config.json` for development. -The configuration file can be externalized by using environment variable `APP_CONFIG_PATH`. +The configuration file can be externalized by using environment variable `DSPACE_APP_CONFIG_PATH`. #### Using environment variables in code To use environment variables in a UI component, use: diff --git a/docs/Configuration.md b/docs/Configuration.md index 193ca0f57d..66d8d492be 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -72,8 +72,8 @@ Settings can be set using the following convention for naming the environment va e.g. ``` -cache.msToLive.default => CACHE_MSTOLIVE_DEFAULT -auth.ui.timeUntilIdle => AUTH_UI_TIMEUNTILIDLE +cache.msToLive.default => DSPACE_CACHE_MSTOLIVE_DEFAULT +auth.ui.timeUntilIdle => DSPACE_AUTH_UI_TIMEUNTILIDLE ``` ## Supporting analytics services other than Google Analytics