Clarify config settings that may need to be re-defined if SERVER_MODE or DATA_DIR are updated in an included config file.

This commit is contained in:
Dave Page 2022-08-01 16:17:49 +01:00
parent 95312f2d14
commit 66a1123268
2 changed files with 9 additions and 7 deletions

View File

@ -45,9 +45,10 @@ The configuration files are as follows:
macOS,/Library/Preferences/pgadmin/config_system.py macOS,/Library/Preferences/pgadmin/config_system.py
Windows,%CommonProgramFiles%\\pgadmin\\config_system.py Windows,%CommonProgramFiles%\\pgadmin\\config_system.py
.. note:: If the SERVER_MODE setting is changed in ``config_distro.py``, .. note:: If the SERVER_MODE or DATA_DIR settings are changed in
``config_local.py``, or ``config_system.py`` you will most likely need to ``config_distro.py``, ``config_local.py``, or ``config_system.py`` you
re-set the LOG_FILE, SQLITE_PATH, SESSION_DB_PATH and STORAGE_DIR values will most likely need to re-set the LOG_FILE, SQLITE_PATH, SESSION_DB_PATH,
STORAGE_DIR, KERBEROS_CCACHE_DIR, and AZURE_CREDENTIAL_CACHE_DIR values
as well as they will have been set based on the default configuration or as well as they will have been set based on the default configuration or
overridden by the runtime. overridden by the runtime.

View File

@ -107,10 +107,11 @@ NODE_BLACKLIST = []
# We only set SERVER_MODE if it's not already set. That's to allow the # We only set SERVER_MODE if it's not already set. That's to allow the
# runtime to force it to False. # runtime to force it to False.
# #
# NOTE: If you change the value of SERVER_MODE in an included config file, # NOTE: If you change the value of SERVER_MODE or DATA_DIR in an included config
# you may also need to redefine any values below that are derived # file, you may also need to redefine any values below that are derived
# from it, notably various paths such as LOG_FILE and anything # from it, notably various paths such as LOG_FILE, SQLITE_PATH,
# using DATA_DIR. # SESSION_DB_PATH, STORAGE_DIR, KERBEROS_CCACHE_DIR, and
# AZURE_CREDENTIAL_CACHE_DIR
if (not hasattr(builtins, 'SERVER_MODE')) or builtins.SERVER_MODE is None: if (not hasattr(builtins, 'SERVER_MODE')) or builtins.SERVER_MODE is None:
SERVER_MODE = True SERVER_MODE = True