|
|
|
|
| <!DOCTYPE html>
|
|
|
| <html lang="en" data-content_root="./">
|
| <head>
|
| <meta charset="utf-8" />
|
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
| <title>The config.py File — pgAdmin 4 8.6 documentation</title>
|
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| <link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
|
|
| <script src="_static/documentation_options.js?v=d4c83366"></script>
|
| <script src="_static/doctools.js?v=9a2dae69"></script>
|
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
|
| <script src="_static/sidebar.js"></script>
|
|
|
| <link rel="index" title="Index" href="genindex.html" />
|
| <link rel="search" title="Search" href="search.html" />
|
| <link rel="next" title="Desktop Deployment" href="desktop_deployment.html" />
|
| <link rel="prev" title="Deployment" href="deployment.html" />
|
| </head><body>
|
| <div class="related" role="navigation" aria-label="related navigation">
|
| <h3>Navigation</h3>
|
| <ul>
|
| <li class="right" style="margin-right: 10px">
|
| <a href="genindex.html" title="General Index"
|
| accesskey="I">index</a></li>
|
| <li class="right" >
|
| <a href="desktop_deployment.html" title="Desktop Deployment"
|
| accesskey="N">next</a> |</li>
|
| <li class="right" >
|
| <a href="deployment.html" title="Deployment"
|
| accesskey="P">previous</a> |</li>
|
| <li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| <li class="nav-item nav-item-1"><a href="getting_started.html" >Getting Started</a> »</li>
|
| <li class="nav-item nav-item-2"><a href="deployment.html" accesskey="U">Deployment</a> »</li>
|
| <li class="nav-item nav-item-this"><a href="">The config.py File</a></li>
|
| </ul>
|
| </div>
|
|
|
| <div class="document">
|
| <div class="documentwrapper">
|
| <div class="bodywrapper">
|
| <div class="body" role="main">
|
|
|
| <section id="the-config-py-file">
|
| <span id="config-py"></span><h1><span class="target" id="index-0"></span>The config.py File<a class="headerlink" href="#the-config-py-file" title="Link to this heading">¶</a></h1>
|
| <p>There are multiple configuration files that are read at startup by pgAdmin. These
|
| files are used for configuration options that:</p>
|
| <ul class="simple">
|
| <li><p>may be required to be set prior to startup of pgAdmin as they control how
|
| the application will operate.</p></li>
|
| <li><p>system administrators may wish to control across an organisation to enforce
|
| security policies.</p></li>
|
| <li><p>are so rarely or unlikely to be changed that it doesn’t
|
| make sense to allow them to be changed through the user interface.</p></li>
|
| </ul>
|
| <p>The configuration files are as follows:</p>
|
| <ul>
|
| <li><p><code class="docutils literal notranslate"><span class="pre">config.py</span></code>: 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 following files.</p></li>
|
| <li><p><code class="docutils literal notranslate"><span class="pre">config_distro.py</span></code>: This file is read after <code class="docutils literal notranslate"><span class="pre">config.py</span></code> and is intended for
|
| packagers to change any settings that are required for their pgAdmin distribution.
|
| This may typically include certain paths and file locations. This file is optional,
|
| and may be created by packagers in the same directory as <code class="docutils literal notranslate"><span class="pre">config.py</span></code> if
|
| needed.</p></li>
|
| <li><p><code class="docutils literal notranslate"><span class="pre">config_local.py</span></code>: This file is read after <code class="docutils literal notranslate"><span class="pre">config_distro.py</span></code> and is intended
|
| for the owner of the installation to change any default or packaging specific settings
|
| that they may wish to adjust to meet local preferences or standards.This file is optional,
|
| and may be created by users in the same directory as <code class="docutils literal notranslate"><span class="pre">config.py</span></code> if
|
| needed.</p></li>
|
| <li><p><code class="docutils literal notranslate"><span class="pre">config_system.py</span></code>: This file is read after <code class="docutils literal notranslate"><span class="pre">config_local.py</span></code> 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
|
| is outside of the pgAdmin installation. The location for this file varies
|
| based on the platform, and only needs to be created if desired.</p>
|
| <table class="docutils align-default">
|
| <thead>
|
| <tr class="row-odd"><th class="head"><p><strong>Platform</strong></p></th>
|
| <th class="head"><p><strong>File Location</strong></p></th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr class="row-even"><td><p>Linux</p></td>
|
| <td><p>/etc/pgadmin/config_system.py</p></td>
|
| </tr>
|
| <tr class="row-odd"><td><p>macOS</p></td>
|
| <td><p>/Library/Preferences/pgadmin/config_system.py</p></td>
|
| </tr>
|
| <tr class="row-even"><td><p>Windows</p></td>
|
| <td><p>%CommonProgramFiles%\pgadmin\config_system.py</p></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| </li>
|
| </ul>
|
| <div class="admonition note">
|
| <p class="admonition-title">Note</p>
|
| <p>If the SERVER_MODE or DATA_DIR settings are changed in
|
| <code class="docutils literal notranslate"><span class="pre">config_distro.py</span></code>, <code class="docutils literal notranslate"><span class="pre">config_local.py</span></code>, or <code class="docutils literal notranslate"><span class="pre">config_system.py</span></code>
|
| LOG_FILE, SQLITE_PATH, SESSION_DB_PATH, STORAGE_DIR, KERBEROS_CCACHE_DIR,
|
| and AZURE_CREDENTIAL_CACHE_DIR values will be set based on DATA_DIR unless
|
| values are explicitly overridden for any of the variable in any of the
|
| above file.</p>
|
| </div>
|
| <p>The default <code class="docutils literal notranslate"><span class="pre">config.py</span></code> file is shown below for reference:</p>
|
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># -*- coding: utf-8 -*-</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># pgAdmin 4 - PostgreSQL Tools</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># Copyright (C) 2013 - 2024, The pgAdmin Development Team</span>
|
| <span class="c1"># This software is released under the PostgreSQL Licence</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># config.py - Core application configuration settings</span>
|
| <span class="c1">#</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="kn">import</span> <span class="nn">builtins</span>
|
| <span class="kn">import</span> <span class="nn">logging</span>
|
| <span class="kn">import</span> <span class="nn">os</span>
|
| <span class="kn">import</span> <span class="nn">sys</span>
|
| <span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">OrderedDict</span>
|
|
|
| <span class="c1"># We need to include the root directory in sys.path to ensure that we can</span>
|
| <span class="c1"># find everything we need when running in the standalone runtime.</span>
|
| <span class="n">root</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))</span>
|
| <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="n">root</span><span class="p">:</span>
|
| <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">root</span><span class="p">)</span>
|
|
|
| <span class="c1"># The config database connection pool size.</span>
|
| <span class="c1"># Setting this to 0 will remove any limit.</span>
|
| <span class="n">CONFIG_DATABASE_CONNECTION_POOL_SIZE</span> <span class="o">=</span> <span class="mi">5</span>
|
| <span class="c1"># The number of connections allowed to overflow beyond</span>
|
| <span class="c1"># the connection pool size.</span>
|
| <span class="n">CONFIG_DATABASE_CONNECTION_MAX_OVERFLOW</span> <span class="o">=</span> <span class="mi">100</span>
|
|
|
| <span class="kn">from</span> <span class="nn">pgadmin.utils</span> <span class="kn">import</span> <span class="n">env</span><span class="p">,</span> <span class="n">IS_WIN</span><span class="p">,</span> <span class="n">fs_short_path</span>
|
| <span class="kn">from</span> <span class="nn">version</span> <span class="kn">import</span> <span class="n">APP_VERSION</span><span class="p">,</span> <span class="n">APP_RELEASE</span><span class="p">,</span> <span class="n">APP_REVISION</span><span class="p">,</span> <span class="n">APP_SUFFIX</span><span class="p">,</span> \
|
| <span class="n">APP_VERSION_INT</span>
|
| <span class="kn">from</span> <span class="nn">branding</span> <span class="kn">import</span> <span class="n">APP_NAME</span><span class="p">,</span> <span class="n">APP_ICON</span><span class="p">,</span> <span class="n">APP_COPYRIGHT</span><span class="p">,</span> <span class="n">APP_PATH</span><span class="p">,</span> \
|
| <span class="n">APP_WIN_PATH</span><span class="p">,</span> <span class="n">APP_SHORT_NAME</span><span class="p">,</span> <span class="n">APP_DEFAULT_EMAIL</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Misc stuff</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># Path to the online help.</span>
|
| <span class="n">HELP_PATH</span> <span class="o">=</span> <span class="s1">'../../../docs/en_US/_build/html/'</span>
|
|
|
| <span class="c1"># Languages we support in the UI</span>
|
| <span class="n">LANGUAGES</span> <span class="o">=</span> <span class="p">{</span>
|
| <span class="s1">'en'</span><span class="p">:</span> <span class="s1">'English'</span><span class="p">,</span>
|
| <span class="s1">'zh'</span><span class="p">:</span> <span class="s1">'Chinese (Simplified)'</span><span class="p">,</span>
|
| <span class="s1">'cs'</span><span class="p">:</span> <span class="s1">'Czech'</span><span class="p">,</span>
|
| <span class="s1">'fr'</span><span class="p">:</span> <span class="s1">'French'</span><span class="p">,</span>
|
| <span class="s1">'de'</span><span class="p">:</span> <span class="s1">'German'</span><span class="p">,</span>
|
| <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'Indonesian'</span><span class="p">,</span>
|
| <span class="s1">'it'</span><span class="p">:</span> <span class="s1">'Italian'</span><span class="p">,</span>
|
| <span class="s1">'ja'</span><span class="p">:</span> <span class="s1">'Japanese'</span><span class="p">,</span>
|
| <span class="s1">'ko'</span><span class="p">:</span> <span class="s1">'Korean'</span><span class="p">,</span>
|
| <span class="s1">'pl'</span><span class="p">:</span> <span class="s1">'Polish'</span><span class="p">,</span>
|
| <span class="s1">'pt_BR'</span><span class="p">:</span> <span class="s1">'Portuguese (Brazilian)'</span><span class="p">,</span>
|
| <span class="s1">'ru'</span><span class="p">:</span> <span class="s1">'Russian'</span><span class="p">,</span>
|
| <span class="s1">'es'</span><span class="p">:</span> <span class="s1">'Spanish'</span><span class="p">,</span>
|
| <span class="p">}</span>
|
|
|
| <span class="c1"># DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING!</span>
|
| <span class="c1"># List of modules to skip when dynamically loading</span>
|
| <span class="n">MODULE_BLACKLIST</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'test'</span><span class="p">]</span>
|
|
|
| <span class="c1"># DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING!</span>
|
| <span class="c1"># List of treeview browser nodes to skip when dynamically loading</span>
|
| <span class="n">NODE_BLACKLIST</span> <span class="o">=</span> <span class="p">[]</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Server settings</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># The server mode determines whether or not we're running on a web server</span>
|
| <span class="c1"># requiring user authentication, or desktop mode which uses an automatic</span>
|
| <span class="c1"># default login.</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># DO NOT DISABLE SERVER MODE IF RUNNING ON A WEBSERVER!!</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># We only set SERVER_MODE if it's not already set. That's to allow the</span>
|
| <span class="c1"># runtime to force it to False.</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># NOTE: If you change the value of SERVER_MODE or DATA_DIR in an included</span>
|
| <span class="c1"># config file, you may also need to redefine any values below that are</span>
|
| <span class="c1"># derived from it, notably various paths such as LOG_FILE, SQLITE_PATH,</span>
|
| <span class="c1"># SESSION_DB_PATH, STORAGE_DIR, KERBEROS_CCACHE_DIR, and</span>
|
| <span class="c1"># AZURE_CREDENTIAL_CACHE_DIR</span>
|
|
|
| <span class="k">if</span> <span class="p">(</span><span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">builtins</span><span class="p">,</span> <span class="s1">'SERVER_MODE'</span><span class="p">))</span> <span class="ow">or</span> <span class="n">builtins</span><span class="o">.</span><span class="n">SERVER_MODE</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
| <span class="n">SERVER_MODE</span> <span class="o">=</span> <span class="kc">True</span>
|
| <span class="k">else</span><span class="p">:</span>
|
| <span class="n">SERVER_MODE</span> <span class="o">=</span> <span class="n">builtins</span><span class="o">.</span><span class="n">SERVER_MODE</span>
|
|
|
| <span class="c1"># HTTP headers to search for CSRF token when it is not provided in the form.</span>
|
| <span class="c1"># Default is ['X-CSRFToken', 'X-CSRF-Token']</span>
|
| <span class="n">WTF_CSRF_HEADERS</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'X-pgA-CSRFToken'</span><span class="p">]</span>
|
|
|
| <span class="c1"># User ID (email address) to use for the default user in desktop mode.</span>
|
| <span class="c1"># The default should be fine here, as it's not exposed in the app.</span>
|
| <span class="n">DESKTOP_USER</span> <span class="o">=</span> <span class="n">APP_DEFAULT_EMAIL</span>
|
|
|
| <span class="c1"># This option allows the user to host the application on a LAN</span>
|
| <span class="c1"># Default hosting is on localhost (DEFAULT_SERVER='localhost').</span>
|
| <span class="c1"># To host pgAdmin4 over LAN set DEFAULT_SERVER='0.0.0.0' (or a specific</span>
|
| <span class="c1"># adaptor address.</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># NOTE: This is NOT recommended for production use, only for debugging</span>
|
| <span class="c1"># or testing. Production installations should be run as a WSGI application</span>
|
| <span class="c1"># behind Apache HTTPD.</span>
|
| <span class="n">DEFAULT_SERVER</span> <span class="o">=</span> <span class="s1">'127.0.0.1'</span>
|
|
|
| <span class="c1"># The default port on which the app server will listen if not set in the</span>
|
| <span class="c1"># environment by the runtime</span>
|
| <span class="n">DEFAULT_SERVER_PORT</span> <span class="o">=</span> <span class="mi">5050</span>
|
|
|
| <span class="c1"># This param is used to override the default web server information about</span>
|
| <span class="c1"># the web technology and the frameworks being used in the application</span>
|
| <span class="c1"># An attacker could use this information to fingerprint underlying operating</span>
|
| <span class="c1"># system and research known exploits for the specific version of</span>
|
| <span class="c1"># software in use</span>
|
| <span class="n">WEB_SERVER</span> <span class="o">=</span> <span class="s1">'Python'</span>
|
|
|
| <span class="c1"># Enable X-Frame-Option protection.</span>
|
| <span class="c1"># Set to one of "SAMEORIGIN", "ALLOW-FROM origin" or "" to disable.</span>
|
| <span class="c1"># Note that "DENY" is NOT supported (and will be silently ignored).</span>
|
| <span class="c1"># See https://tools.ietf.org/html/rfc7034 for more info.</span>
|
| <span class="n">X_FRAME_OPTIONS</span> <span class="o">=</span> <span class="s2">"SAMEORIGIN"</span>
|
|
|
| <span class="c1"># The Content-Security-Policy header allows you to restrict how resources</span>
|
| <span class="c1"># such as JavaScript, CSS, or pretty much anything that the browser loads.</span>
|
| <span class="c1"># see https://content-security-policy.com/#source_list for more info</span>
|
| <span class="c1"># e.g. "default-src https: data: 'unsafe-inline' 'unsafe-eval';"</span>
|
| <span class="n">CONTENT_SECURITY_POLICY</span> <span class="o">=</span> <span class="s2">"default-src ws: http: data: blob: 'unsafe-inline'"</span> \
|
| <span class="s2">" 'unsafe-eval';"</span>
|
|
|
| <span class="c1"># STRICT_TRANSPORT_SECURITY_ENABLED when set to True will set the</span>
|
| <span class="c1"># Strict-Transport-Security header</span>
|
| <span class="n">STRICT_TRANSPORT_SECURITY_ENABLED</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
| <span class="c1"># The Strict-Transport-Security header tells the browser to convert all HTTP</span>
|
| <span class="c1"># requests to HTTPS, preventing man-in-the-middle (MITM) attacks.</span>
|
| <span class="c1"># e.g. 'max-age=31536000; includeSubDomains'</span>
|
| <span class="n">STRICT_TRANSPORT_SECURITY</span> <span class="o">=</span> <span class="s2">"max-age=31536000; includeSubDomains"</span>
|
|
|
| <span class="c1"># The X-Content-Type-Options header forces the browser to honor the response</span>
|
| <span class="c1"># content type instead of trying to detect it, which can be abused to</span>
|
| <span class="c1"># generate a cross-site scripting (XSS) attack.</span>
|
| <span class="c1"># e.g. nosniff</span>
|
| <span class="n">X_CONTENT_TYPE_OPTIONS</span> <span class="o">=</span> <span class="s2">"nosniff"</span>
|
|
|
| <span class="c1"># The browser will try to prevent reflected XSS attacks by not loading the</span>
|
| <span class="c1"># page if the request contains something that looks like JavaScript and the</span>
|
| <span class="c1"># response contains the same data. e.g. '1; mode=block'</span>
|
| <span class="n">X_XSS_PROTECTION</span> <span class="o">=</span> <span class="s2">"1; mode=block"</span>
|
|
|
| <span class="c1"># This param is used to validate ALLOWED_HOSTS for the application</span>
|
| <span class="c1"># This will be used to avoid Host Header Injection attack</span>
|
| <span class="c1"># ALLOWED_HOSTS = ['225.0.0.0/8', '226.0.0.0/7', '228.0.0.0/6']</span>
|
| <span class="c1"># ALLOWED_HOSTS = ['127.0.0.1', '192.168.0.1']</span>
|
| <span class="c1"># if ALLOWED_HOSTS= [] then it will accept all ips (and application will be</span>
|
| <span class="c1"># vulnerable to Host Header Injection attack)</span>
|
| <span class="n">ALLOWED_HOSTS</span> <span class="o">=</span> <span class="p">[]</span>
|
|
|
| <span class="c1"># Hashing algorithm used for password storage</span>
|
| <span class="n">SECURITY_PASSWORD_HASH</span> <span class="o">=</span> <span class="s1">'pbkdf2_sha512'</span>
|
|
|
| <span class="c1"># Minimum password length</span>
|
| <span class="n">PASSWORD_LENGTH_MIN</span> <span class="o">=</span> <span class="mi">6</span>
|
|
|
| <span class="c1"># Reverse Proxy parameters</span>
|
| <span class="c1"># You must tell the middleware how many proxies set each header</span>
|
| <span class="c1"># so it knows what values to trust.</span>
|
| <span class="c1"># See https://tinyurl.com/yyg7r9av</span>
|
| <span class="c1"># for more information.</span>
|
|
|
| <span class="c1"># Number of values to trust for X-Forwarded-For</span>
|
| <span class="n">PROXY_X_FOR_COUNT</span> <span class="o">=</span> <span class="mi">1</span>
|
|
|
| <span class="c1"># Number of values to trust for X-Forwarded-Proto.</span>
|
| <span class="n">PROXY_X_PROTO_COUNT</span> <span class="o">=</span> <span class="mi">1</span>
|
|
|
| <span class="c1"># Number of values to trust for X-Forwarded-Host.</span>
|
| <span class="n">PROXY_X_HOST_COUNT</span> <span class="o">=</span> <span class="mi">0</span>
|
|
|
| <span class="c1"># Number of values to trust for X-Forwarded-Port.</span>
|
| <span class="n">PROXY_X_PORT_COUNT</span> <span class="o">=</span> <span class="mi">1</span>
|
|
|
| <span class="c1"># Number of values to trust for X-Forwarded-Prefix.</span>
|
| <span class="n">PROXY_X_PREFIX_COUNT</span> <span class="o">=</span> <span class="mi">0</span>
|
|
|
| <span class="c1"># NOTE: CSRF_SESSION_KEY, SECRET_KEY and SECURITY_PASSWORD_SALT are no</span>
|
| <span class="c1"># longer part of the main configuration, but are stored in the</span>
|
| <span class="c1"># configuration databases 'keys' table and are auto-generated.</span>
|
|
|
| <span class="c1"># COMPRESSION</span>
|
| <span class="n">COMPRESS_MIMETYPES</span> <span class="o">=</span> <span class="p">[</span>
|
| <span class="s1">'text/html'</span><span class="p">,</span> <span class="s1">'text/css'</span><span class="p">,</span> <span class="s1">'text/xml'</span><span class="p">,</span> <span class="s1">'text/javascript'</span><span class="p">,</span>
|
| <span class="s1">'application/json'</span><span class="p">,</span> <span class="s1">'application/javascript'</span>
|
| <span class="p">]</span>
|
| <span class="n">COMPRESS_LEVEL</span> <span class="o">=</span> <span class="mi">9</span>
|
| <span class="n">COMPRESS_MIN_SIZE</span> <span class="o">=</span> <span class="mi">500</span>
|
|
|
| <span class="c1"># Set the cache control max age for static files in flask to 1 year</span>
|
| <span class="n">SEND_FILE_MAX_AGE_DEFAULT</span> <span class="o">=</span> <span class="mi">31556952</span>
|
|
|
| <span class="c1"># This will be added to static urls as url parameter with value as</span>
|
| <span class="c1"># APP_VERSION_INT for cache busting on version upgrade. If the value is set as</span>
|
| <span class="c1"># None or empty string then it will not be added.</span>
|
| <span class="c1"># eg - http:localhost:5050/pgadmin.css?intver=3.13</span>
|
| <span class="n">APP_VERSION_PARAM</span> <span class="o">=</span> <span class="s1">'ver'</span>
|
|
|
| <span class="c1"># Add the internal version param to below extensions only</span>
|
| <span class="n">APP_VERSION_EXTN</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'.css'</span><span class="p">,</span> <span class="s1">'.js'</span><span class="p">,</span> <span class="s1">'.html'</span><span class="p">,</span> <span class="s1">'.svg'</span><span class="p">,</span> <span class="s1">'.png'</span><span class="p">,</span> <span class="s1">'.gif'</span><span class="p">,</span> <span class="s1">'.ico'</span><span class="p">)</span>
|
|
|
| <span class="c1"># Data directory for storage of config settings etc. This shouldn't normally</span>
|
| <span class="c1"># need to be changed - it's here as various other settings depend on it.</span>
|
| <span class="c1"># On Windows, we always store data in %APPDATA%\$(APP_WIN_PATH). On other</span>
|
| <span class="c1"># platforms, if we're in server mode we use /var/lib/$(APP_PATH),</span>
|
| <span class="c1"># otherwise ~/.$(APP_PATH)</span>
|
| <span class="k">if</span> <span class="n">IS_WIN</span><span class="p">:</span>
|
| <span class="c1"># Use the short path on windows</span>
|
| <span class="n">DATA_DIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span>
|
| <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">fs_short_path</span><span class="p">(</span><span class="n">env</span><span class="p">(</span><span class="s1">'APPDATA'</span><span class="p">)),</span> <span class="n">APP_WIN_PATH</span><span class="p">)</span>
|
| <span class="p">)</span>
|
| <span class="k">else</span><span class="p">:</span>
|
| <span class="k">if</span> <span class="n">SERVER_MODE</span><span class="p">:</span>
|
| <span class="n">DATA_DIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s1">'/var/lib/'</span><span class="p">,</span> <span class="n">APP_PATH</span><span class="p">)</span>
|
| <span class="k">else</span><span class="p">:</span>
|
| <span class="n">DATA_DIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span>
|
| <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="s1">'~/'</span> <span class="o">+</span> <span class="s1">'.'</span> <span class="o">+</span> <span class="n">APP_PATH</span> <span class="o">+</span> <span class="s1">'/'</span><span class="p">)</span>
|
| <span class="p">)</span>
|
|
|
| <span class="c1"># An optional login banner to show security warnings/disclaimers etc. at</span>
|
| <span class="c1"># login and password recovery etc. HTML may be included for basic formatting,</span>
|
| <span class="c1"># For example:</span>
|
| <span class="c1"># LOGIN_BANNER = "<h4>Authorised Users Only!</h4>" \</span>
|
| <span class="c1"># "Unauthorised use is strictly forbidden."</span>
|
| <span class="n">LOGIN_BANNER</span> <span class="o">=</span> <span class="s2">""</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Log settings</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># Debug mode?</span>
|
| <span class="n">DEBUG</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
| <span class="c1"># Application log level - one of:</span>
|
| <span class="c1"># CRITICAL 50</span>
|
| <span class="c1"># ERROR 40</span>
|
| <span class="c1"># WARNING 30</span>
|
| <span class="c1"># SQL 25</span>
|
| <span class="c1"># INFO 20</span>
|
| <span class="c1"># DEBUG 10</span>
|
| <span class="c1"># NOTSET 0</span>
|
| <span class="n">CONSOLE_LOG_LEVEL</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">WARNING</span>
|
| <span class="n">FILE_LOG_LEVEL</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">WARNING</span>
|
|
|
| <span class="c1"># Log format.</span>
|
| <span class="n">JSON_LOGGER</span> <span class="o">=</span> <span class="kc">False</span>
|
| <span class="n">CONSOLE_LOG_FORMAT_JSON</span> <span class="o">=</span> <span class="n">OrderedDict</span><span class="p">([</span>
|
| <span class="p">(</span><span class="s2">"time"</span><span class="p">,</span> <span class="s2">"asctime"</span><span class="p">),</span>
|
| <span class="p">(</span><span class="s2">"message"</span><span class="p">,</span> <span class="s2">"message"</span><span class="p">),</span>
|
| <span class="p">(</span><span class="s2">"level"</span><span class="p">,</span> <span class="s2">"levelname"</span><span class="p">)</span>
|
| <span class="p">])</span>
|
|
|
| <span class="n">FILE_LOG_FORMAT_JSON</span> <span class="o">=</span> <span class="n">OrderedDict</span><span class="p">([</span>
|
| <span class="p">(</span><span class="s2">"time"</span><span class="p">,</span> <span class="s2">"asctime"</span><span class="p">),</span>
|
| <span class="p">(</span><span class="s2">"message"</span><span class="p">,</span> <span class="s2">"message"</span><span class="p">),</span>
|
| <span class="p">(</span><span class="s2">"level"</span><span class="p">,</span> <span class="s2">"levelname"</span><span class="p">)</span>
|
| <span class="p">])</span>
|
|
|
|
|
| <span class="n">CONSOLE_LOG_FORMAT</span> <span class="o">=</span> <span class="s1">'</span><span class="si">%(asctime)s</span><span class="s1">: </span><span class="si">%(levelname)s</span><span class="se">\t</span><span class="si">%(name)s</span><span class="s1">:</span><span class="se">\t</span><span class="si">%(message)s</span><span class="s1">'</span>
|
| <span class="n">FILE_LOG_FORMAT</span> <span class="o">=</span> <span class="s1">'</span><span class="si">%(asctime)s</span><span class="s1">: </span><span class="si">%(levelname)s</span><span class="se">\t</span><span class="si">%(name)s</span><span class="s1">:</span><span class="se">\t</span><span class="si">%(message)s</span><span class="s1">'</span>
|
|
|
| <span class="c1"># Log file name. This goes in the data directory, except on non-Windows</span>
|
| <span class="c1"># platforms in server mode.</span>
|
| <span class="k">if</span> <span class="n">SERVER_MODE</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">IS_WIN</span><span class="p">:</span>
|
| <span class="n">LOG_FILE</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s1">'/var/log'</span><span class="p">,</span> <span class="n">APP_PATH</span><span class="p">,</span> <span class="n">APP_SHORT_NAME</span> <span class="o">+</span> <span class="s1">'.log'</span><span class="p">)</span>
|
| <span class="k">else</span><span class="p">:</span>
|
| <span class="n">LOG_FILE</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">DATA_DIR</span><span class="p">,</span> <span class="n">APP_SHORT_NAME</span> <span class="o">+</span> <span class="s1">'.log'</span><span class="p">)</span>
|
|
|
| <span class="c1"># Log rotation setting</span>
|
| <span class="c1"># Log file will be rotated considering values for LOG_ROTATION_SIZE</span>
|
| <span class="c1"># & LOG_ROTATION_AGE. Rotated file will be named in format</span>
|
| <span class="c1"># - LOG_FILE.Y-m-d_H-M-S</span>
|
| <span class="n">LOG_ROTATION_SIZE</span> <span class="o">=</span> <span class="mi">10</span> <span class="c1"># In MBs</span>
|
| <span class="n">LOG_ROTATION_AGE</span> <span class="o">=</span> <span class="mi">1440</span> <span class="c1"># In minutes</span>
|
| <span class="n">LOG_ROTATION_MAX_LOG_FILES</span> <span class="o">=</span> <span class="mi">90</span> <span class="c1"># Maximum number of backups to retain</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Server Connection Driver Settings</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># The default driver used for making connection with PostgreSQL</span>
|
| <span class="n">PG_DEFAULT_DRIVER</span> <span class="o">=</span> <span class="s1">'psycopg3'</span>
|
|
|
| <span class="c1"># Maximum allowed idle time in minutes before which releasing the connection</span>
|
| <span class="c1"># for the particular session. (in minutes)</span>
|
| <span class="n">MAX_SESSION_IDLE_TIME</span> <span class="o">=</span> <span class="mi">60</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># External Database Settings</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># All configuration settings are stored by default in the SQLite database.</span>
|
| <span class="c1"># In order to use external databases like PostgreSQL sets the value of</span>
|
| <span class="c1"># CONFIG_DATABASE_URI like below:</span>
|
| <span class="c1"># dialect+driver://username:password@host:port/database</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># PostgreSQL:</span>
|
| <span class="c1"># postgresql://username:password@host:port/database</span>
|
| <span class="c1"># Specify Schema Name</span>
|
| <span class="c1"># postgresql://username:password@host:port/database?options=-csearch_path=pgadmin</span>
|
| <span class="c1"># Using PGPASS file</span>
|
| <span class="c1"># postgresql://username@host:port?options=-csearch_path=pgadmin</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">CONFIG_DATABASE_URI</span> <span class="o">=</span> <span class="s1">''</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># User account and settings storage</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># The default path to the SQLite database used to store user accounts and</span>
|
| <span class="c1"># settings. This default places the file in the same directory as this</span>
|
| <span class="c1"># config file, but generates an absolute path for use througout the app.</span>
|
| <span class="n">SQLITE_PATH</span> <span class="o">=</span> <span class="n">env</span><span class="p">(</span><span class="s1">'SQLITE_PATH'</span><span class="p">)</span> <span class="ow">or</span> \
|
| <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">DATA_DIR</span><span class="p">,</span> <span class="n">APP_SHORT_NAME</span> <span class="o">+</span> <span class="s1">'.db'</span><span class="p">)</span>
|
|
|
| <span class="c1"># SQLITE_TIMEOUT will define how long to wait before throwing the error -</span>
|
| <span class="c1"># OperationError due to database lock. On slower system, you may need to change</span>
|
| <span class="c1"># this to some higher value.</span>
|
| <span class="c1"># (Default: 500 milliseconds)</span>
|
| <span class="n">SQLITE_TIMEOUT</span> <span class="o">=</span> <span class="mi">500</span>
|
|
|
| <span class="c1"># Allow database connection passwords to be saved if the user chooses.</span>
|
| <span class="c1"># Set to False to disable password saving.</span>
|
| <span class="n">ALLOW_SAVE_PASSWORD</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="c1"># Maximum number of history queries stored per user/server/database</span>
|
| <span class="n">MAX_QUERY_HIST_STORED</span> <span class="o">=</span> <span class="mi">20</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Server-side session storage path</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># SESSION_DB_PATH (Default: $HOME/.pgadmin4/sessions)</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># We use SQLite for server-side session storage. There will be one</span>
|
| <span class="c1"># SQLite database object per session created.</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># Specify the path used to store your session objects.</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># If the specified directory does not exist, the setup script will create</span>
|
| <span class="c1"># it with permission mode 700 to keep the session database secure.</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># On certain systems, you can use shared memory (tmpfs) for maximum</span>
|
| <span class="c1"># scalability, for example, on Ubuntu:</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># SESSION_DB_PATH = '/run/shm/pgAdmin4_session'</span>
|
| <span class="c1">#</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">SESSION_DB_PATH</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">DATA_DIR</span><span class="p">,</span> <span class="s1">'sessions'</span><span class="p">)</span>
|
|
|
| <span class="n">SESSION_COOKIE_NAME</span> <span class="o">=</span> <span class="s1">'pga4_session'</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Mail server settings</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># These settings are used when running in web server mode for confirming</span>
|
| <span class="c1"># and resetting passwords etc.</span>
|
| <span class="c1"># See: http://pythonhosted.org/Flask-Mail/ for more info</span>
|
| <span class="n">MAIL_SERVER</span> <span class="o">=</span> <span class="s1">'localhost'</span>
|
| <span class="n">MAIL_PORT</span> <span class="o">=</span> <span class="mi">25</span>
|
| <span class="n">MAIL_USE_SSL</span> <span class="o">=</span> <span class="kc">False</span>
|
| <span class="n">MAIL_USE_TLS</span> <span class="o">=</span> <span class="kc">False</span>
|
| <span class="n">MAIL_USERNAME</span> <span class="o">=</span> <span class="s1">''</span>
|
| <span class="n">MAIL_PASSWORD</span> <span class="o">=</span> <span class="s1">''</span>
|
| <span class="n">MAIL_DEBUG</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
| <span class="c1"># Flask-Security overrides Flask-Mail's MAIL_DEFAULT_SENDER setting, so</span>
|
| <span class="c1"># that should be set as such:</span>
|
| <span class="n">SECURITY_EMAIL_SENDER</span> <span class="o">=</span> <span class="s1">'no-reply@localhost'</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Mail content settings</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># These settings define the content of password reset emails</span>
|
| <span class="n">SECURITY_EMAIL_SUBJECT_PASSWORD_RESET</span> <span class="o">=</span> <span class="s2">"Password reset instructions for </span><span class="si">%s</span><span class="s2">"</span> \
|
| <span class="o">%</span> <span class="n">APP_NAME</span>
|
| <span class="n">SECURITY_EMAIL_SUBJECT_PASSWORD_NOTICE</span> <span class="o">=</span> <span class="s2">"Your </span><span class="si">%s</span><span class="s2"> password has been reset"</span> \
|
| <span class="o">%</span> <span class="n">APP_NAME</span>
|
| <span class="n">SECURITY_EMAIL_SUBJECT_PASSWORD_CHANGE_NOTICE</span> <span class="o">=</span> \
|
| <span class="s2">"Your password for </span><span class="si">%s</span><span class="s2"> has been changed"</span> <span class="o">%</span> <span class="n">APP_NAME</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Email address validation</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">CHECK_EMAIL_DELIVERABILITY</span> <span class="o">=</span> <span class="kc">False</span>
|
| <span class="n">SECURITY_EMAIL_VALIDATOR_ARGS</span> <span class="o">=</span> \
|
| <span class="p">{</span><span class="s2">"check_deliverability"</span><span class="p">:</span> <span class="n">CHECK_EMAIL_DELIVERABILITY</span><span class="p">}</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Upgrade checks</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># Check for new versions of the application?</span>
|
| <span class="n">UPGRADE_CHECK_ENABLED</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="c1"># Where should we get the data from?</span>
|
| <span class="n">UPGRADE_CHECK_URL</span> <span class="o">=</span> <span class="s1">'https://www.pgadmin.org/versions.json'</span>
|
|
|
| <span class="c1"># What key should we look at in the upgrade data file?</span>
|
| <span class="n">UPGRADE_CHECK_KEY</span> <span class="o">=</span> <span class="s1">'pgadmin4'</span>
|
|
|
| <span class="c1"># Which CA file should we use?</span>
|
| <span class="c1"># Default to cacert.pem in the same directory as config.py et al.</span>
|
| <span class="n">CA_FILE</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)),</span>
|
| <span class="s2">"cacert.pem"</span><span class="p">)</span>
|
|
|
| <span class="c1"># Check if the detected browser is supported</span>
|
| <span class="n">CHECK_SUPPORTED_BROWSER</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Storage Manager storage url config settings</span>
|
| <span class="c1"># If user sets STORAGE_DIR to empty it will show all volumes if platform</span>
|
| <span class="c1"># is Windows, '/' if it is Linux, Mac or any other unix type system.</span>
|
|
|
| <span class="c1"># For example:</span>
|
| <span class="c1"># 1. STORAGE_DIR = get_drive("C") or get_drive() # return C:/ by default</span>
|
| <span class="c1"># where C can be any drive character such as "D", "E", "G" etc</span>
|
| <span class="c1"># 2. Set path manually like</span>
|
| <span class="c1"># STORAGE_DIR = "/path/to/directory/"</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">STORAGE_DIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">DATA_DIR</span><span class="p">,</span> <span class="s1">'storage'</span><span class="p">)</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Default locations for binary utilities (pg_dump, pg_restore etc)</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># These are intentionally left empty in the main config file, but are</span>
|
| <span class="c1"># expected to be overridden by packagers in config_distro.py.</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># A default location can be specified for each database driver ID, in</span>
|
| <span class="c1"># a dictionary. Either an absolute or relative path can be specified.</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># Version-specific defaults can also be specified, which will take priority</span>
|
| <span class="c1"># over un-versioned paths.</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># In cases where it may be difficult to know what the working directory</span>
|
| <span class="c1"># is, "$DIR" can be specified. This will be replaced with the path to the</span>
|
| <span class="c1"># top-level pgAdmin4.py file. For example, on macOS we might use:</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># $DIR/../../SharedSupport</span>
|
| <span class="c1">#</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">DEFAULT_BINARY_PATHS</span> <span class="o">=</span> <span class="p">{</span>
|
| <span class="s2">"pg"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"pg-12"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"pg-13"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"pg-14"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"pg-15"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"pg-16"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"ppas"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"ppas-12"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"ppas-13"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"ppas-14"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"ppas-15"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"ppas-16"</span><span class="p">:</span> <span class="s2">""</span>
|
| <span class="p">}</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># Admin can specify fixed binary paths to prevent users from changing.</span>
|
| <span class="c1"># It will take precedence over DEFAULT_BINARY_PATHS.</span>
|
|
|
| <span class="n">FIXED_BINARY_PATHS</span> <span class="o">=</span> <span class="p">{</span>
|
| <span class="s2">"pg"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"pg-12"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"pg-13"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"pg-14"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"pg-15"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"pg-16"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"ppas"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"ppas-12"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"ppas-13"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"ppas-14"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"ppas-15"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| <span class="s2">"ppas-16"</span><span class="p">:</span> <span class="s2">""</span>
|
| <span class="p">}</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Test settings - used primarily by the regression suite, not for users</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># The default path for SQLite database for testing</span>
|
| <span class="n">TEST_SQLITE_PATH</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">DATA_DIR</span><span class="p">,</span> <span class="s1">'test_pgadmin4.db'</span><span class="p">)</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Allows flask application to response to the each request asynchronously</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">THREADED_MODE</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Do not allow SQLALCHEMY to track modification as it is going to be</span>
|
| <span class="c1"># deprecated in future</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">SQLALCHEMY_TRACK_MODIFICATIONS</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Number of records to fetch in one batch in query tool when query result</span>
|
| <span class="c1"># set is large.</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">ON_DEMAND_RECORD_COUNT</span> <span class="o">=</span> <span class="mi">1000</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Allow users to display Gravatar image for their username in Server mode</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">SHOW_GRAVATAR_IMAGE</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Set cookie path and options</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">COOKIE_DEFAULT_PATH</span> <span class="o">=</span> <span class="s1">'/'</span>
|
| <span class="n">COOKIE_DEFAULT_DOMAIN</span> <span class="o">=</span> <span class="kc">None</span>
|
| <span class="n">SESSION_COOKIE_DOMAIN</span> <span class="o">=</span> <span class="kc">None</span>
|
| <span class="n">SESSION_COOKIE_SAMESITE</span> <span class="o">=</span> <span class="s1">'Lax'</span>
|
| <span class="n">SESSION_COOKIE_SECURE</span> <span class="o">=</span> <span class="kc">False</span>
|
| <span class="n">SESSION_COOKIE_HTTPONLY</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="c1">#########################################################################</span>
|
| <span class="c1"># Skip storing session in files and cache for specific paths</span>
|
| <span class="c1">#########################################################################</span>
|
| <span class="n">SESSION_SKIP_PATHS</span> <span class="o">=</span> <span class="p">[</span>
|
| <span class="s1">'/misc/ping'</span>
|
| <span class="p">]</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Session expiration support</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># SESSION_EXPIRATION_TIME is the interval in Days. Session will be</span>
|
| <span class="c1"># expire after the specified number of *days*.</span>
|
| <span class="n">SESSION_EXPIRATION_TIME</span> <span class="o">=</span> <span class="mi">1</span>
|
|
|
| <span class="c1"># Make SESSION_EXPIRATION_TIME to 1 week in DESKTOP mode</span>
|
| <span class="k">if</span> <span class="ow">not</span> <span class="n">SERVER_MODE</span><span class="p">:</span>
|
| <span class="n">SESSION_EXPIRATION_TIME</span> <span class="o">=</span> <span class="mi">7</span>
|
|
|
| <span class="c1"># CHECK_SESSION_FILES_INTERVAL is interval in Hours. Application will check</span>
|
| <span class="c1"># the session files for cleanup after specified number of *hours*.</span>
|
| <span class="n">CHECK_SESSION_FILES_INTERVAL</span> <span class="o">=</span> <span class="mi">24</span>
|
|
|
| <span class="c1"># USER_INACTIVITY_TIMEOUT is interval in Seconds. If the pgAdmin screen is left</span>
|
| <span class="c1"># unattended for <USER_INACTIVITY_TIMEOUT> seconds then the user will</span>
|
| <span class="c1"># be logged out. When set to 0, the timeout will be disabled.</span>
|
| <span class="c1"># If pgAdmin doesn't detect any activity in the time specified (in seconds),</span>
|
| <span class="c1"># the user will be forcibly logged out from pgAdmin. Set to zero to disable</span>
|
| <span class="c1"># the timeout.</span>
|
| <span class="c1"># Note: This is applicable only for SERVER_MODE=True.</span>
|
| <span class="n">USER_INACTIVITY_TIMEOUT</span> <span class="o">=</span> <span class="mi">0</span>
|
|
|
| <span class="c1"># OVERRIDE_USER_INACTIVITY_TIMEOUT when set to True will override</span>
|
| <span class="c1"># USER_INACTIVITY_TIMEOUT when long running queries in the Query Tool</span>
|
| <span class="c1"># or Debugger are running. When the queries complete, the inactivity timer</span>
|
| <span class="c1"># will restart in this case. If set to False, user inactivity may cause</span>
|
| <span class="c1"># transactions or in-process debugging sessions to be aborted.</span>
|
| <span class="n">OVERRIDE_USER_INACTIVITY_TIMEOUT</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># SSH Tunneling supports only for Python 2.7 and 3.4+</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">SUPPORT_SSH_TUNNEL</span> <span class="o">=</span> <span class="kc">True</span>
|
| <span class="c1"># Allow SSH Tunnel passwords to be saved if the user chooses.</span>
|
| <span class="c1"># Set to False to disable password saving.</span>
|
| <span class="n">ALLOW_SAVE_TUNNEL_PASSWORD</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Master password is used to encrypt/decrypt saved server passwords</span>
|
| <span class="c1"># Applicable for desktop mode only</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">MASTER_PASSWORD_REQUIRED</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># pgAdmin encrypts the database connection and ssh tunnel password using a</span>
|
| <span class="c1"># master password or pgAdmin login password (for other authentication sources)</span>
|
| <span class="c1"># before storing it in the pgAdmin configuration database.</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># Below setting is used to allow the user to specify the path to a script</span>
|
| <span class="c1"># or program that will return an encryption key which will be used to</span>
|
| <span class="c1"># encrypt the passwords. This setting is used only in server mode when</span>
|
| <span class="c1"># auth sources are oauth, Kerberos, and webserver.</span>
|
| <span class="c1">#</span>
|
| <span class="c1"># You can pass the current username as an argument to the external script</span>
|
| <span class="c1"># by specifying %u in config value.</span>
|
| <span class="c1"># E.g. - MASTER_PASSWORD_HOOK = '<PATH>/passwdgen_script.sh %u'</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">MASTER_PASSWORD_HOOK</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># Allows pgAdmin4 to create session cookies based on IP address, so even</span>
|
| <span class="c1"># if a cookie is stolen, the attacker will not be able to connect to the</span>
|
| <span class="c1"># server using that stolen cookie.</span>
|
| <span class="c1"># Note: This can cause problems when the server is deployed in dynamic IP</span>
|
| <span class="c1"># address hosting environments, such as Kubernetes or behind load</span>
|
| <span class="c1"># balancers. In such cases, this option should be set to False.</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">ENHANCED_COOKIE_PROTECTION</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># External Authentication Sources</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># Default setting is internal</span>
|
| <span class="c1"># External Supported Sources: ldap, kerberos, oauth2</span>
|
| <span class="c1"># Multiple authentication can be achieved by setting this parameter to</span>
|
| <span class="c1"># ['ldap', 'internal'] or ['oauth2', 'internal'] or</span>
|
| <span class="c1"># ['webserver', 'internal'] etc.</span>
|
| <span class="c1"># pgAdmin will authenticate the user with ldap/oauth2 whatever first in the</span>
|
| <span class="c1"># list, in case of failure the second authentication option will be considered.</span>
|
|
|
| <span class="n">AUTHENTICATION_SOURCES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'internal'</span><span class="p">]</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># MAX_LOGIN_ATTEMPTS which sets the number of failed login attempts that</span>
|
| <span class="c1"># are allowed. If this value is exceeded the account is locked and can be</span>
|
| <span class="c1"># reset by an administrator. By setting the variable to the value zero</span>
|
| <span class="c1"># this feature is deactivated.</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">MAX_LOGIN_ATTEMPTS</span> <span class="o">=</span> <span class="mi">3</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Only consider password to check the failed login attempts, email is</span>
|
| <span class="c1"># excluded from this check</span>
|
| <span class="n">LOGIN_ATTEMPT_FIELDS</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'password'</span><span class="p">]</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># LDAP Configuration</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># After ldap authentication, user will be added into the SQLite database</span>
|
| <span class="c1"># automatically, if set to True.</span>
|
| <span class="c1"># Set it to False, if user should not be added automatically,</span>
|
| <span class="c1"># in this case Admin has to add the user manually in the SQLite database.</span>
|
| <span class="n">LDAP_AUTO_CREATE_USER</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="c1"># Connection timeout</span>
|
| <span class="n">LDAP_CONNECTION_TIMEOUT</span> <span class="o">=</span> <span class="mi">10</span>
|
|
|
| <span class="c1"># Server connection details (REQUIRED)</span>
|
| <span class="c1"># example: ldap://<ip-address>:<port> or ldap://<hostname>:<port></span>
|
| <span class="n">LDAP_SERVER_URI</span> <span class="o">=</span> <span class="s1">'ldap://<ip-address>:<port>'</span>
|
|
|
| <span class="c1"># The LDAP attribute containing user names. In OpenLDAP, this may be 'uid'</span>
|
| <span class="c1"># whilst in AD, 'sAMAccountName' might be appropriate. (REQUIRED)</span>
|
| <span class="n">LDAP_USERNAME_ATTRIBUTE</span> <span class="o">=</span> <span class="s1">'<User-id>'</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># 3 ways to configure LDAP as follows (Choose anyone):</span>
|
|
|
| <span class="c1"># 1. Dedicated User binding</span>
|
|
|
| <span class="c1"># LDAP Bind User DN Example: cn=username,dc=example,dc=com</span>
|
| <span class="c1"># Set this parameter to allow the connection to bind using a dedicated user.</span>
|
| <span class="c1"># After the connection is made, the pgadmin login user will be further</span>
|
| <span class="c1"># authenticated by the username and password provided</span>
|
| <span class="c1"># at the login screen.</span>
|
| <span class="n">LDAP_BIND_USER</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
| <span class="c1"># LDAP Bind User Password</span>
|
| <span class="n">LDAP_BIND_PASSWORD</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
| <span class="c1"># OR ####################</span>
|
| <span class="c1"># 2. Anonymous Binding</span>
|
|
|
| <span class="c1"># Set this parameter to allow the anonymous bind.</span>
|
| <span class="c1"># After the connection is made, the pgadmin login user will be further</span>
|
| <span class="c1"># authenticated by the username and password provided</span>
|
|
|
| <span class="n">LDAP_ANONYMOUS_BIND</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
| <span class="c1"># OR ####################</span>
|
| <span class="c1"># 3. Bind as pgAdmin user</span>
|
|
|
| <span class="c1"># BaseDN (REQUIRED)</span>
|
| <span class="c1"># AD example:</span>
|
| <span class="c1"># (&(objectClass=user)(memberof=CN=MYGROUP,CN=Users,dc=example,dc=com))</span>
|
| <span class="c1"># OpenLDAP example: CN=Users,dc=example,dc=com</span>
|
| <span class="n">LDAP_BASE_DN</span> <span class="o">=</span> <span class="s1">'<Base-DN>'</span>
|
|
|
| <span class="c1"># Configure the bind format string</span>
|
| <span class="c1"># Default: LDAP_BIND_FORMAT="</span>
|
| <span class="c1"># {LDAP_USERNAME_ATTRIBUTE}={LDAP_USERNAME},{LDAP_BASE_DN}"</span>
|
| <span class="c1"># The current available options are:</span>
|
| <span class="c1"># LDAP_USERNAME_ATTRIBUTE, LDAP_USERNAME, LDAP_BASE_DN</span>
|
| <span class="c1"># Example: LDAP_BIND_FORMAT="myldapuser@sales.example.com"</span>
|
| <span class="c1"># LDAP_BIND_FORMAT="NET\\myldapuser"</span>
|
| <span class="n">LDAP_BIND_FORMAT</span> <span class="o">=</span> <span class="s1">'</span><span class="si">{LDAP_USERNAME_ATTRIBUTE}</span><span class="s1">=</span><span class="si">{LDAP_USERNAME}</span><span class="s1">,</span><span class="si">{LDAP_BASE_DN}</span><span class="s1">'</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># Search ldap for further authentication (REQUIRED)</span>
|
| <span class="c1"># It can be optional while bind as pgAdmin user</span>
|
| <span class="n">LDAP_SEARCH_BASE_DN</span> <span class="o">=</span> <span class="s1">'<Search-Base-DN>'</span>
|
|
|
| <span class="c1"># The LDAP attribute indicates whether the DN (Distinguished Names)</span>
|
| <span class="c1"># are case sensitive or not</span>
|
| <span class="n">LDAP_DN_CASE_SENSITIVE</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
| <span class="c1"># Filter string for the user search.</span>
|
| <span class="c1"># For OpenLDAP, '(cn=*)' may well be enough.</span>
|
| <span class="c1"># For AD, you might use '(objectClass=user)' (REQUIRED)</span>
|
| <span class="n">LDAP_SEARCH_FILTER</span> <span class="o">=</span> <span class="s1">'(objectclass=*)'</span>
|
|
|
| <span class="c1"># Search scope for users (one of BASE, LEVEL or SUBTREE)</span>
|
| <span class="n">LDAP_SEARCH_SCOPE</span> <span class="o">=</span> <span class="s1">'SUBTREE'</span>
|
|
|
| <span class="c1"># Use TLS? If the URI scheme is ldaps://, this is ignored.</span>
|
| <span class="n">LDAP_USE_STARTTLS</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
| <span class="c1"># TLS/SSL certificates. Specify if required, otherwise leave empty</span>
|
| <span class="n">LDAP_CA_CERT_FILE</span> <span class="o">=</span> <span class="s1">''</span>
|
| <span class="n">LDAP_CERT_FILE</span> <span class="o">=</span> <span class="s1">''</span>
|
| <span class="n">LDAP_KEY_FILE</span> <span class="o">=</span> <span class="s1">''</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># Some flaky LDAP servers returns malformed schema. If True, no exception</span>
|
| <span class="c1"># will be raised and schema is thrown away but authentication will be done.</span>
|
| <span class="c1"># This parameter should remain False, as recommended.</span>
|
| <span class="n">LDAP_IGNORE_MALFORMED_SCHEMA</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Kerberos Configuration</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="n">KRB_APP_HOST_NAME</span> <span class="o">=</span> <span class="n">DEFAULT_SERVER</span>
|
|
|
| <span class="c1"># If the default_keytab_name is not set in krb5.conf or</span>
|
| <span class="c1"># the KRB_KTNAME environment variable is not set then, explicitly set</span>
|
| <span class="c1"># the Keytab file</span>
|
|
|
| <span class="n">KRB_KTNAME</span> <span class="o">=</span> <span class="s1">'<KRB5_KEYTAB_FILE>'</span>
|
|
|
| <span class="c1"># After kerberos authentication, user will be added into the SQLite database</span>
|
| <span class="c1"># automatically, if set to True.</span>
|
| <span class="c1"># Set it to False, if user should not be added automatically,</span>
|
| <span class="c1"># in this case Admin has to add the user manually in the SQLite database.</span>
|
|
|
| <span class="n">KRB_AUTO_CREATE_USER</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="n">KERBEROS_CCACHE_DIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">DATA_DIR</span><span class="p">,</span> <span class="s1">'krbccache'</span><span class="p">)</span>
|
|
|
| <span class="c1">#############################################################################</span>
|
| <span class="c1"># Create local directory to store azure credential cache</span>
|
| <span class="c1">#############################################################################</span>
|
|
|
| <span class="n">AZURE_CREDENTIAL_CACHE_DIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">DATA_DIR</span><span class="p">,</span> <span class="s1">'azurecredentialcache'</span><span class="p">)</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># OAuth2 Configuration</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># Multiple OAUTH2 providers can be added in the list like [{...},{...}]</span>
|
| <span class="c1"># All parameters are required</span>
|
|
|
| <span class="n">OAUTH2_CONFIG</span> <span class="o">=</span> <span class="p">[</span>
|
| <span class="p">{</span>
|
| <span class="c1"># The name of the of the oauth provider, ex: github, google</span>
|
| <span class="s1">'OAUTH2_NAME'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| <span class="c1"># The display name, ex: Google</span>
|
| <span class="s1">'OAUTH2_DISPLAY_NAME'</span><span class="p">:</span> <span class="s1">'<Oauth2 Display Name>'</span><span class="p">,</span>
|
| <span class="c1"># Oauth client id</span>
|
| <span class="s1">'OAUTH2_CLIENT_ID'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| <span class="c1"># Oauth secret</span>
|
| <span class="s1">'OAUTH2_CLIENT_SECRET'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| <span class="c1"># URL to generate a token,</span>
|
| <span class="c1"># Ex: https://github.com/login/oauth/access_token</span>
|
| <span class="s1">'OAUTH2_TOKEN_URL'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| <span class="c1"># URL is used for authentication,</span>
|
| <span class="c1"># Ex: https://github.com/login/oauth/authorize</span>
|
| <span class="s1">'OAUTH2_AUTHORIZATION_URL'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| <span class="c1"># server metadata url might optional for your provider</span>
|
| <span class="s1">'OAUTH2_SERVER_METADATA_URL'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| <span class="c1"># Oauth base url, ex: https://api.github.com/</span>
|
| <span class="s1">'OAUTH2_API_BASE_URL'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| <span class="c1"># Name of the Endpoint, ex: user</span>
|
| <span class="s1">'OAUTH2_USERINFO_ENDPOINT'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| <span class="c1"># Oauth scope, ex: 'openid email profile'</span>
|
| <span class="c1"># Note that an 'email' claim is required in the resulting profile</span>
|
| <span class="s1">'OAUTH2_SCOPE'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| <span class="c1"># The claim which is used for the username. If the value is empty the</span>
|
| <span class="c1"># email is used as username, but if a value is provided,</span>
|
| <span class="c1"># the claim has to exist.</span>
|
| <span class="s1">'OAUTH2_USERNAME_CLAIM'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| <span class="c1"># Font-awesome icon, ex: fa-github</span>
|
| <span class="s1">'OAUTH2_ICON'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| <span class="c1"># UI button colour, ex: #0000ff</span>
|
| <span class="s1">'OAUTH2_BUTTON_COLOR'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| <span class="c1"># The additional claims to check on user ID Token or Userinfo response.</span>
|
| <span class="c1"># This is useful to provide additional authorization checks</span>
|
| <span class="c1"># before allowing access.</span>
|
| <span class="c1"># Example for GitLab: allowing all maintainers teams, and a specific</span>
|
| <span class="c1"># developers group to access pgadmin:</span>
|
| <span class="c1"># 'OAUTH2_ADDITIONAL_CLAIMS': {</span>
|
| <span class="c1"># 'https://gitlab.org/claims/groups/maintainer': [</span>
|
| <span class="c1"># 'kuberheads/applications',</span>
|
| <span class="c1"># 'kuberheads/dba',</span>
|
| <span class="c1"># 'kuberheads/support'</span>
|
| <span class="c1"># ],</span>
|
| <span class="c1"># 'https://gitlab.org/claims/groups/developer': [</span>
|
| <span class="c1"># 'kuberheads/applications/team01'</span>
|
| <span class="c1"># ],</span>
|
| <span class="c1"># }</span>
|
| <span class="c1"># Example for AzureAD:</span>
|
| <span class="c1"># 'OAUTH2_ADDITIONAL_CLAIMS': {</span>
|
| <span class="c1"># 'groups': ["0760b6cf-170e-4a14-91b3-4b78e0739963"],</span>
|
| <span class="c1"># 'wids': ["cf1c38e5-3621-4004-a7cb-879624dced7c"],</span>
|
| <span class="c1"># }</span>
|
| <span class="s1">'OAUTH2_ADDITIONAL_CLAIMS'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| <span class="c1"># Set this variable to False to disable SSL certificate verification</span>
|
| <span class="c1"># for OAuth2 provider.</span>
|
| <span class="c1"># This may need to set False, in case of self-signed certificates.</span>
|
| <span class="c1"># Ref: https://github.com/psf/requests/issues/6071</span>
|
| <span class="s1">'OAUTH2_SSL_CERT_VERIFICATION'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
|
| <span class="c1"># set this variable to invalidate the session of the oauth2 provider</span>
|
| <span class="c1"># Example for keycloak:</span>
|
| <span class="c1"># 'OAUTH2_LOGOUT_URL':</span>
|
| <span class="c1"># 'https://example.com/realms/master/protocol/openid-connect/logout?post_logout_redirect_uri={redirect_uri}&id_token_hint={id_token}'</span>
|
| <span class="s1">'OAUTH2_LOGOUT_URL'</span><span class="p">:</span> <span class="kc">None</span>
|
| <span class="p">}</span>
|
| <span class="p">]</span>
|
|
|
| <span class="c1"># After Oauth authentication, user will be added into the SQLite database</span>
|
| <span class="c1"># automatically, if set to True.</span>
|
| <span class="c1"># Set it to False, if user should not be added automatically,</span>
|
| <span class="c1"># in this case Admin has to add the user manually in the SQLite database.</span>
|
|
|
| <span class="n">OAUTH2_AUTO_CREATE_USER</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Webserver Configuration</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="n">WEBSERVER_AUTO_CREATE_USER</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="c1"># REMOTE_USER variable will be used to check the environment variable</span>
|
| <span class="c1"># is set or not first, if not available,</span>
|
| <span class="c1"># request header will be checked for the same.</span>
|
| <span class="c1"># Possible values: REMOTE_USER, HTTP_X_FORWARDED_USER, X-Forwarded-User</span>
|
|
|
| <span class="n">WEBSERVER_REMOTE_USER</span> <span class="o">=</span> <span class="s1">'REMOTE_USER'</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># Two-factor Authentication Configuration</span>
|
| <span class="c1">##########################################################################</span>
|
|
|
| <span class="c1"># Set it to True, to enable the two-factor authentication</span>
|
| <span class="n">MFA_ENABLED</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="c1"># Set it to True, to ask the users to register forcefully for the</span>
|
| <span class="c1"># two-authentication methods on logged-in.</span>
|
| <span class="n">MFA_FORCE_REGISTRATION</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
| <span class="c1"># pgAdmin supports Two-factor authentication by either sending an one-time code</span>
|
| <span class="c1"># to an email, or using the TOTP based application like Google Authenticator.</span>
|
| <span class="n">MFA_SUPPORTED_METHODS</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"email"</span><span class="p">,</span> <span class="s2">"authenticator"</span><span class="p">]</span>
|
|
|
| <span class="c1"># NOTE: Please set the 'Mail server settings' to use 'email' as two-factor</span>
|
| <span class="c1"># authentication method.</span>
|
|
|
| <span class="c1"># Subject for the email verification code</span>
|
| <span class="c1"># Default: <APP_NAME> - Verification Code</span>
|
| <span class="c1"># e.g. pgAdmin 4 - Verification Code</span>
|
| <span class="n">MFA_EMAIL_SUBJECT</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># PSQL tool settings</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># This will enable PSQL tool in pgAdmin when running in server mode.</span>
|
| <span class="c1"># PSQL is always enabled in Desktop mode, however in server mode it is</span>
|
| <span class="c1"># disabled by default because users can run arbitrary commands on the</span>
|
| <span class="c1"># server through it.</span>
|
| <span class="n">ENABLE_PSQL</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># ENABLE_BINARY_PATH_BROWSING setting is used to enable the browse button</span>
|
| <span class="c1"># while selecting binary path for the database server in server mode.</span>
|
| <span class="c1"># In Desktop mode it is always enabled and setting is of no use.</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">ENABLE_BINARY_PATH_BROWSING</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
| <span class="c1">##########################################################################</span>
|
| <span class="c1"># In server mode, the SHARED_STORAGE setting is used to enable shared storage.</span>
|
| <span class="c1"># Specify the name, path, and restricted_access values that should be shared</span>
|
| <span class="c1"># between users. When restricted_access is set to True, non-admin users cannot</span>
|
| <span class="c1"># upload/add, delete, or rename files/folders in shared storage, only admins</span>
|
| <span class="c1"># can do that. Users must provide the absolute path to the folder, and the name</span>
|
| <span class="c1"># can be anything they see on the user interface.</span>
|
| <span class="c1"># [{ 'name': 'Shared 1', 'path': '/shared_folder',</span>
|
| <span class="c1"># 'restricted_access': True/False}]</span>
|
| <span class="c1">##########################################################################</span>
|
| <span class="n">SHARED_STORAGE</span> <span class="o">=</span> <span class="p">[]</span>
|
|
|
| <span class="c1">#############################################################################</span>
|
| <span class="c1"># AUTO_DISCOVER_SERVERS setting is used to enable the pgAdmin to discover the</span>
|
| <span class="c1"># database server automatically on the local machine.</span>
|
| <span class="c1"># When it is set to False, pgAdmin will not discover servers installed on</span>
|
| <span class="c1"># the local machine.</span>
|
| <span class="c1">#############################################################################</span>
|
| <span class="n">AUTO_DISCOVER_SERVERS</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
| <span class="c1">#############################################################################</span>
|
| <span class="c1"># SERVER_HEARTBEAT_TIMEOUT is used to send the server heartbeat to server</span>
|
| <span class="c1"># from the client. This will resolve the orphan database issue once</span>
|
| <span class="c1"># browser tab is closed.</span>
|
| <span class="c1">#############################################################################</span>
|
| <span class="n">SERVER_HEARTBEAT_TIMEOUT</span> <span class="o">=</span> <span class="mi">30</span> <span class="c1"># In seconds</span>
|
|
|
| <span class="c1">#############################################################################</span>
|
| <span class="c1"># ENABLE_SERVER_PASS_EXEC_CMD is used to enable/disable Password exec command</span>
|
| <span class="c1"># field in server properties. This is used to specify a shell command to be</span>
|
| <span class="c1"># executed to retrieve a password to be used for server authentication.</span>
|
| <span class="c1"># This setting is applicable only for server mode.</span>
|
| <span class="c1">#############################################################################</span>
|
| <span class="n">ENABLE_SERVER_PASS_EXEC_CMD</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
| <span class="c1">#############################################################################</span>
|
| <span class="c1"># Patch the default config with custom config and other manipulations</span>
|
| <span class="c1">#############################################################################</span>
|
| <span class="kn">from</span> <span class="nn">pgadmin.evaluate_config</span> <span class="kn">import</span> <span class="n">evaluate_and_patch_config</span>
|
| <span class="nb">locals</span><span class="p">()</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">evaluate_and_patch_config</span><span class="p">(</span><span class="nb">locals</span><span class="p">()))</span>
|
| </pre></div>
|
| </div>
|
| </section>
|
|
|
|
|
| <div class="clearer"></div>
|
| </div>
|
| </div>
|
| </div>
|
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| <div class="sphinxsidebarwrapper">
|
| <h3><a href="index.html">Table of Contents</a></h3>
|
| <ul class="current">
|
| <li class="toctree-l1 current"><a class="reference internal" href="getting_started.html">Getting Started</a><ul class="current">
|
| <li class="toctree-l2 current"><a class="reference internal" href="deployment.html">Deployment</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="login.html">Login Page</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="mfa.html">Enabling two-factor authentication (2FA)</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="user_management.html">User Management Dialog</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="change_ownership.html">Change Ownership Dialog</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="change_user_password.html">Change User Password Dialog</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="restore_locked_user.html">Lock/Restore Account</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="ldap.html">Enabling LDAP Authentication</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="kerberos.html">Enabling Kerberos Authentication</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="oauth2.html">Enabling OAUTH2 Authentication</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="webserver.html">Enabling Webserver Authentication</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="user_interface.html">User Interface</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="menu_bar.html">Menu Bar</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="toolbar.html">Toolbar</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="tabbed_browser.html">Tabbed Browser</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="tree_control.html">Tree Control</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="preferences.html">Preferences Dialog</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts:</a></li>
|
| <li class="toctree-l2"><a class="reference internal" href="search_objects.html">Search objects</a></li>
|
| </ul>
|
| </li>
|
| <li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| <li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| <li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| <li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| <li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| <li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| <li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| <li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| <li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| <li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| <li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| <li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| <li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| </ul>
|
|
|
| <search id="searchbox" style="display: none" role="search">
|
| <h3 id="searchlabel">Quick search</h3>
|
| <div class="searchformwrapper">
|
| <form class="search" action="search.html" method="get">
|
| <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| <input type="submit" value="Go" />
|
| </form>
|
| </div>
|
| </search>
|
| <script>document.getElementById('searchbox').style.display = "block"</script>
|
| </div>
|
| <div id="sidebarbutton" title="Collapse sidebar">
|
| <span>«</span>
|
| </div>
|
|
|
| </div>
|
| <div class="clearer"></div>
|
| </div>
|
| <div class="related" role="navigation" aria-label="related navigation">
|
| <h3>Navigation</h3>
|
| <ul>
|
| <li class="right" style="margin-right: 10px">
|
| <a href="genindex.html" title="General Index"
|
| >index</a></li>
|
| <li class="right" >
|
| <a href="desktop_deployment.html" title="Desktop Deployment"
|
| >next</a> |</li>
|
| <li class="right" >
|
| <a href="deployment.html" title="Deployment"
|
| >previous</a> |</li>
|
| <li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| <li class="nav-item nav-item-1"><a href="getting_started.html" >Getting Started</a> »</li>
|
| <li class="nav-item nav-item-2"><a href="deployment.html" >Deployment</a> »</li>
|
| <li class="nav-item nav-item-this"><a href="">The config.py File</a></li>
|
| </ul>
|
| </div>
|
| <div class="footer" role="contentinfo">
|
| <div class="related" role="navigation" aria-label="related navigation">
|
| <ul>
|
| <li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| <li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| <li class="right" ><a href="desktop_deployment.html" title="Desktop Deployment" accesskey="N">next</a> |</li>
|
| <li class="right" ><a href="deployment.html" title="Deployment" accesskey="P">previous</a> |</li>
|
| </ul>
|
| </div>
|
| </div>
|
| </body>
|
| </html> |
