pgAdmin config files

November 14, 2022

There are multiple configuration files that are read at startup by pgAdmin. These files can be used to modify the default configuration options or to add any configuration which a user needs to define only once. 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 in one of the files which we will discuss further.

config_distro.py


This file is read after the config.py and is intended for packagers to change any settings that are required for their pgAdmin distribution. This may include certain paths and file locations specific to the packaging or platform. This file is optional and must be created in the same directory as config.py.

config_local.py


This file is read after config_distro.py and is intended for end users to change any default or packaging specific settings. This may include settings like adding oAuth or LDAP config, changing the application mode or any other configuration which the end user might want to change. This file is also optional and can be created in the same directory as config.py.

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 unprivileged users can not modify, outside the pgAdmin installation. The location for this file varies based on platform, and is optional. The location of file based on platform is as follows:

File Location

You can check all the configurations available in config.py from here.

Conclusion


Config files can be used to modify the pgAdmin configurations by users, packager manager or system administrators to handle how applications loads and behaves.
 

Share this

More Blogs

PGVector as Embedding Store in PrivateGPT

EDB has a long history of open source contributions, and while we’re best known for our contributions to Postgres, that’s not the only project we contribute to. e.g Barman, CloudNativePG...
June 05, 2024

pgAdmin User Management in Server Mode

pgAdmin can be deployed as a web application by configuring the app to run in server mode. One can check out server deployment on how to run pgAdmin in server...
August 24, 2023

pgAdmin CI/CD

Almost exactly three years ago I wrote a blog on my personal page entitled Testing pgAdmin which went into great detail discussing how we test pgAdmin prior to releases. Back...
August 24, 2023