diff --git a/docs/en_US/config_py.rst b/docs/en_US/config_py.rst index 79ab6440b..9b3da7f63 100644 --- a/docs/en_US/config_py.rst +++ b/docs/en_US/config_py.rst @@ -5,7 +5,16 @@ *************************** There are multiple configuration files that are read at startup by pgAdmin. These -are as follows: +files are used for configuration options that: + +* may be required to be set prior to startup of pgAdmin as they control how + the application will operate. +* system administrators may wish to control across an organisation to enforce + security policies. +* are so rarely or unlikely to be changed that it doesn't + make sense to allow them to be changed through the user interface. + +The configuration files are as follows: * ``config.py``: This is the main configuration file, and should not be modified. It can be used as a reference for configuration settings, that may be overridden @@ -27,11 +36,14 @@ are as follows: intended for system administrators to include settings that are configured system-wide from a secure location that users cannot normally modify and that is outside of the pgAdmin installation. The location for this file varies - based on the platform, and only needs to be created if desired: + based on the platform, and only needs to be created if desired. - * Linux: ``/etc/pgadmin/config_system.py`` - * macOS: ``/Library/Preferences/pgadmin/config_system.py`` - * Windows: ``%CommonProgramFiles%\pgadmin\config_system.py`` + .. csv-table:: + :header: "**Platform**", "**File Location**" + + Linux,/etc/pgadmin/config_system.py + macOS,/Library/Preferences/pgadmin/config_system.py + Windows,%CommonProgramFiles%\pgadmin\config_system.py .. note:: If the SERVER_MODE setting is changed in ``config_distro.py``, ``config_local.py``, or ``config_system.py`` you will most likely need to diff --git a/docs/en_US/master_password.rst b/docs/en_US/master_password.rst index 803b90722..ced1c7eb5 100644 --- a/docs/en_US/master_password.rst +++ b/docs/en_US/master_password.rst @@ -18,9 +18,10 @@ passwords. This is applicable only for desktop mode users. :alt: Set master password :align: center -* You can disable the master password by setting the configuration parameter - *MASTER_PASSWORD_REQUIRED=False*. See :ref:`Desktop Deployment ` - for more information. +.. note:: pgAdmin aims to be **secure by default**, however, you can disable the master + password by setting the configuration parameter *MASTER_PASSWORD_REQUIRED=False*. + See :ref:`config_py` for more information on configuration parameters and how + they can be changed or enforced across an organisation. .. note:: If the master password is disabled, then all the saved passwords will be removed.