|
|
|
|
| <!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>Desktop Deployment — 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="Server Deployment" href="server_deployment.html" />
|
| <link rel="prev" title="The config.py File" href="config_py.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="server_deployment.html" title="Server Deployment"
|
| accesskey="N">next</a> |</li>
|
| <li class="right" >
|
| <a href="config_py.html" title="The config.py File"
|
| 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="">Desktop Deployment</a></li>
|
| </ul>
|
| </div>
|
|
|
| <div class="document">
|
| <div class="documentwrapper">
|
| <div class="bodywrapper">
|
| <div class="body" role="main">
|
|
|
| <section id="desktop-deployment">
|
| <span id="id1"></span><h1><span class="target" id="index-0"></span>Desktop Deployment<a class="headerlink" href="#desktop-deployment" title="Link to this heading">¶</a></h1>
|
| <p>pgAdmin may be deployed as a desktop application by configuring the application
|
| to run in desktop mode and then utilising the desktop runtime to host the
|
| program on a supported Windows, Mac OS X or Linux installation.</p>
|
| <p>The desktop runtime is a standalone application that when launched, runs the
|
| pgAdmin server and opens a window to render the user interface.</p>
|
| <div class="admonition note">
|
| <p class="admonition-title">Note</p>
|
| <p>Pre-compiled and configured installation packages are available for
|
| a number of platforms. These packages should be used by end-users whereever
|
| possible - the following information is useful for the maintainers of those
|
| packages and users interested in understanding how pgAdmin works.</p>
|
| </div>
|
| <div class="admonition seealso">
|
| <p class="admonition-title">See also</p>
|
| <p>For detailed instructions on building and configuring pgAdmin from
|
| scratch, please see the README file in the top level directory of the source code.
|
| For convenience, you can find the latest version of the file
|
| <a class="reference external" href="https://github.com/pgadmin-org/pgadmin4/blob/master/README.md">here</a>,
|
| but be aware that this may differ from the version included with the source code
|
| for a specific version of pgAdmin.</p>
|
| </div>
|
| <section id="configuration">
|
| <h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
| <p>From pgAdmin 4 v2 onwards, the default configuration mode is server, however,
|
| this is overridden by the desktop runtime at startup. In most environments, no
|
| Python configuration is required unless you wish to override other default
|
| settings.</p>
|
| <p>See <a class="reference internal" href="config_py.html#config-py"><span class="std std-ref">The config.py File</span></a> for more information on configuration settings.</p>
|
| <section id="desktop-runtime-standalone-application">
|
| <h3>Desktop Runtime Standalone Application<a class="headerlink" href="#desktop-runtime-standalone-application" title="Link to this heading">¶</a></h3>
|
| <p>The Desktop Runtime is based on <a class="reference external" href="https://nwjs.io/">NWjs</a> which integrates a
|
| browser and the Python server creating a standalone application.</p>
|
| <img alt="Runtime Standalone" class="align-center" src="_images/runtime_standalone.png" />
|
| <section id="runtime-menu">
|
| <h4>Runtime Menu<a class="headerlink" href="#runtime-menu" title="Link to this heading">¶</a></h4>
|
| <img alt="Runtime Menu" class="align-center" src="_images/runtime_menu.png" />
|
| <p>Use the <em>File Menu</em> to access the <em>Runtime Menu</em>:</p>
|
| <table class="docutils align-default">
|
| <thead>
|
| <tr class="row-odd"><th class="head"><p>Option</p></th>
|
| <th class="head"><p>Action</p></th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr class="row-even"><td><p><em>Configure…</em></p></td>
|
| <td><p>Click to open configuration dialog to configure fixed port, port number and connection timeout.</p></td>
|
| </tr>
|
| <tr class="row-odd"><td><p><em>View log…</em></p></td>
|
| <td><p>Click to open the view log dialog to view the pgAdmin 4 logs.</p></td>
|
| </tr>
|
| <tr class="row-even"><td><p><em>Enter Full Screen</em></p></td>
|
| <td><p>Click to enter/exit the full screen mode. Keyboard Shortcuts: OSX (Cmd + Ctrl + F), Other OS (F10).</p></td>
|
| </tr>
|
| <tr class="row-odd"><td><p><em>Actual Size</em></p></td>
|
| <td><p>Click to change the window size to it original size. Keyboard Shortcuts: OSX (Cmd + 0),
|
| Other OS (Ctrl + 0).</p></td>
|
| </tr>
|
| <tr class="row-even"><td><p><em>Zoom In</em></p></td>
|
| <td><p>Click to increase the zoom level. Keyboard Shortcuts: OSX (Cmd + +), Other OS (Ctrl + +).</p></td>
|
| </tr>
|
| <tr class="row-odd"><td><p><em>Zoom Out</em></p></td>
|
| <td><p>Click to decrease the zoom level. Keyboard Shortcuts: OSX (Cmd + -), Other OS (Ctrl + -).</p></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| </section>
|
| <section id="configuration-dialog">
|
| <h4>Configuration Dialog<a class="headerlink" href="#configuration-dialog" title="Link to this heading">¶</a></h4>
|
| <p>Use the <em>Runtime Menu</em> to access the <em>Configuration</em> dialog:</p>
|
| <img alt="Runtime Configuration" class="align-center" src="_images/runtime_configuration.png" />
|
| <p>Following are the details of the <em>Fixed port number?</em>, <em>Port Number</em>, <em>Connection
|
| Timeout</em>, and ‘Open Documentation in Default Browser?’ configuration parameters:</p>
|
| <table class="longtable docutils align-default">
|
| <colgroup>
|
| <col style="width: 28.6%" />
|
| <col style="width: 14.3%" />
|
| <col style="width: 57.1%" />
|
| </colgroup>
|
| <thead>
|
| <tr class="row-odd"><th class="head"><p>Key</p></th>
|
| <th class="head"><p>Type</p></th>
|
| <th class="head"><p>Purpose</p></th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr class="row-even"><td><p>FixedPort</p></td>
|
| <td><p>Boolean</p></td>
|
| <td><p>Use a fixed network port number rather than a random one.</p></td>
|
| </tr>
|
| <tr class="row-odd"><td><p>PortNumber</p></td>
|
| <td><p>Integer</p></td>
|
| <td><p>The port number to use, if using a fixed port.</p></td>
|
| </tr>
|
| <tr class="row-even"><td><p>ConnectionTimeout</p></td>
|
| <td><p>Integer</p></td>
|
| <td><p>The number of seconds to wait for application server startup.</p></td>
|
| </tr>
|
| <tr class="row-odd"><td><p>Open Documentation in Default Browser</p></td>
|
| <td><p>Boolean</p></td>
|
| <td><p>By checking this option, all documentation links will open in
|
| the default browser instead of in a new window.</p></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| </section>
|
| <section id="log-dialog">
|
| <h4>Log dialog<a class="headerlink" href="#log-dialog" title="Link to this heading">¶</a></h4>
|
| <p>Use the <em>Runtime Menu</em> to access the <em>Log</em> dialog:</p>
|
| <img alt="Runtime View Log" class="align-center" src="_images/runtime_view_log.png" />
|
| <p>Click on the <em>Reload</em> button at the bottom to view the latest logs of pgAdmin 4
|
| Server.</p>
|
| <p>When executed, the runtime will automatically try to execute the pgAdmin Python
|
| application. If execution fails, it will prompt you with error message
|
| displaying a <em>Configure</em> button at the bottom. You can configure a fixed port
|
| number to avoid clashes of the default random port number with other
|
| applications and a connection timeout if desired.</p>
|
| <img alt="Runtime Error" class="align-center" src="_images/runtime_error.png" />
|
| <p>If the error is related to Python Path or pgAdmin Python file then you need to
|
| create a file named ‘dev_config.json’ and specify the following entries:</p>
|
| <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
| <span class="w"> </span><span class="nt">"pythonPath"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/path/to/python.exe"</span><span class="p">,</span>
|
| <span class="w"> </span><span class="nt">"pgadminFile"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/path/to/pgAdmin4.py"</span>
|
| <span class="p">}</span>
|
| </pre></div>
|
| </div>
|
| <p>Note that the <em>dev_config.py</em> file should only be required by developers who are
|
| working outside of a standard installation.</p>
|
| <p>The configuration settings are stored in <em>runtime_config.json</em> file, which
|
| will be available on Unix systems (~/.local/share/pgadmin/),
|
| on Mac OS X (~/Library/Preferences/pgadmin),
|
| and on Windows (%APPDATA%/pgadmin).</p>
|
| </section>
|
| </section>
|
| </section>
|
| </section>
|
|
|
|
|
| <div class="clearer"></div>
|
| </div>
|
| </div>
|
| </div>
|
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| <div class="sphinxsidebarwrapper">
|
| <div>
|
| <h3><a href="index.html">Table of Contents</a></h3>
|
| <ul>
|
| <li><a class="reference internal" href="#">Desktop Deployment</a><ul>
|
| <li><a class="reference internal" href="#configuration">Configuration</a><ul>
|
| <li><a class="reference internal" href="#desktop-runtime-standalone-application">Desktop Runtime Standalone Application</a><ul>
|
| <li><a class="reference internal" href="#runtime-menu">Runtime Menu</a></li>
|
| <li><a class="reference internal" href="#configuration-dialog">Configuration Dialog</a></li>
|
| <li><a class="reference internal" href="#log-dialog">Log dialog</a></li>
|
| </ul>
|
| </li>
|
| </ul>
|
| </li>
|
| </ul>
|
| </li>
|
| </ul>
|
|
|
| </div>
|
| <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="server_deployment.html" title="Server Deployment"
|
| >next</a> |</li>
|
| <li class="right" >
|
| <a href="config_py.html" title="The config.py File"
|
| >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="">Desktop Deployment</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="server_deployment.html" title="Server Deployment" accesskey="N">next</a> |</li>
|
| <li class="right" ><a href="config_py.html" title="The config.py File" accesskey="P">previous</a> |</li>
|
| </ul>
|
| </div>
|
| </div>
|
| </body>
|
| </html> |
