Clarify the configuration files documentation. #5369 (#10571)

* Document that config_local.py is lost on upgrade on macOS. #5369

* Retitle the config_py docs page to 'Configuration Files', as it covers all four configuration files. #5369
This commit is contained in:
Dave Page authored and GitHub committed 2026-10-14 14:27:01 +01:00
1 parent 5f6d72c686
commit d699acab0b
1 file changed
+9 -3
+9 -3
View File
@@ -1,8 +1,8 @@
.. _config_py:
***************************
`The config.py File`:index:
***************************
*****************************
`Configuration Files`:index:
*****************************
There are multiple configuration files that are read at startup by pgAdmin. These
files are used for configuration options that:
@@ -32,6 +32,12 @@ The configuration files are as follows:
and may be created by users in the same directory as ``config.py`` if
needed.
.. note:: On macOS, ``config.py`` is located inside the application bundle
(``pgAdmin 4.app/Contents/Resources/web/``), which is replaced in its
entirety when pgAdmin is upgraded, so a ``config_local.py`` file created
there will be lost. Use ``config_system.py`` instead, which is stored
outside the application bundle.
* ``config_system.py``: This file is read after ``config_local.py`` and is
intended for system administrators to include settings that are configured
system-wide from a secure location that users cannot normally modify and that