codekingpro/portable-devtools
114k
1
2
3<!DOCTYPE html>
4
5<html lang="en" data-content_root="./">
6 <head>
7 <meta charset="utf-8" />
8 <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
9
10 <title>Getting Started — pgAdmin 4 8.6 documentation</title>
11 <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
12 <link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
13
14 <script src="_static/documentation_options.js?v=d4c83366"></script>
15 <script src="_static/doctools.js?v=9a2dae69"></script>
16 <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
17
18 <script src="_static/sidebar.js"></script>
19
20 <link rel="index" title="Index" href="genindex.html" />
21 <link rel="search" title="Search" href="search.html" />
22 <link rel="next" title="Deployment" href="deployment.html" />
23 <link rel="prev" title="pgAdmin 4" href="index.html" />
24 </head><body>
25 <div class="related" role="navigation" aria-label="related navigation">
26 <h3>Navigation</h3>
27 <ul>
28 <li class="right" style="margin-right: 10px">
29 <a href="genindex.html" title="General Index"
30 accesskey="I">index</a></li>
31 <li class="right" >
32 <a href="deployment.html" title="Deployment"
33 accesskey="N">next</a> |</li>
34 <li class="right" >
35 <a href="index.html" title="pgAdmin 4"
36 accesskey="P">previous</a> |</li>
37 <li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
38 <li class="nav-item nav-item-this"><a href="">Getting Started</a></li>
39 </ul>
40 </div>
41
42 <div class="document">
43 <div class="documentwrapper">
44 <div class="bodywrapper">
45 <div class="body" role="main">
46
47 <section id="getting-started">
48<span id="id1"></span><h1><span class="target" id="index-0"></span>Getting Started<a class="headerlink" href="#getting-started" title="Link to this heading">¶</a></h1>
49<p>Pre-compiled and configured installation packages for pgAdmin 4 are available
50for a number of desktop environments; we recommend using an installer
51whenever possible.</p>
52<p>In a <em>Server Deployment</em>, the pgAdmin application is deployed behind a webserver
53or with the WSGI interface.
54If you install pgAdmin in server mode, you will be prompted to provide a role
55name and pgAdmin password when you initially connect to pgAdmin. The first
56role registered with pgAdmin will be an administrative user; the
57administrative role can use the pgAdmin <em>User Management</em> dialog to create
58and manage additional pgAdmin user accounts. When a user authenticates
59with pgAdmin, the pgAdmin tree control displays the server definitions
60associated with that login role.</p>
61<p>In a <em>Desktop Deployment</em>, the pgAdmin application is configured to use the
62desktop runtime environment to host the program on a supported platform.
63Typically, users will install a pre-built package to run pgAdmin in desktop
64mode, but a manual desktop deployment can be installed and though it is more
65difficult to setup, it may be useful for developers interested in understanding
66how pgAdmin works.</p>
67<p>It is also possible to use a <em>Container Deployment</em> of pgAdmin, in which Server
68Mode is pre-configured for security.</p>
69<div class="toctree-wrapper compound">
70<ul>
71<li class="toctree-l1"><a class="reference internal" href="deployment.html">Deployment</a><ul>
72<li class="toctree-l2"><a class="reference internal" href="config_py.html">The config.py File</a></li>
73<li class="toctree-l2"><a class="reference internal" href="desktop_deployment.html">Desktop Deployment</a></li>
74<li class="toctree-l2"><a class="reference internal" href="server_deployment.html">Server Deployment</a></li>
75<li class="toctree-l2"><a class="reference internal" href="container_deployment.html">Container Deployment</a></li>
76</ul>
77</li>
78<li class="toctree-l1"><a class="reference internal" href="login.html">Login Page</a><ul>
79<li class="toctree-l2"><a class="reference internal" href="login.html#recovering-a-lost-password">Recovering a Lost Password</a></li>
80<li class="toctree-l2"><a class="reference internal" href="login.html#avoiding-a-bruteforce-attack">Avoiding a bruteforce attack</a></li>
81</ul>
82</li>
83<li class="toctree-l1"><a class="reference internal" href="mfa.html">Enabling two-factor authentication (2FA)</a><ul>
84<li class="toctree-l2"><a class="reference internal" href="mfa.html#about-two-factor-authentication">About two-factor authentication</a></li>
85<li class="toctree-l2"><a class="reference internal" href="mfa.html#setup-two-factor-authentication">Setup two-factor authentication</a></li>
86<li class="toctree-l2"><a class="reference internal" href="mfa.html#configure-two-factor-authentication">Configure two-factor authentication</a></li>
87</ul>
88</li>
89<li class="toctree-l1"><a class="reference internal" href="user_management.html">User Management Dialog</a><ul>
90<li class="toctree-l2"><a class="reference internal" href="user_management.html#using-setup-py-command-line-script">Using ‘setup.py’ command line script</a></li>
91</ul>
92</li>
93<li class="toctree-l1"><a class="reference internal" href="change_ownership.html">Change Ownership Dialog</a></li>
94<li class="toctree-l1"><a class="reference internal" href="change_user_password.html">Change User Password Dialog</a></li>
95<li class="toctree-l1"><a class="reference internal" href="restore_locked_user.html">Lock/Restore Account</a></li>
96<li class="toctree-l1"><a class="reference internal" href="ldap.html">Enabling LDAP Authentication</a></li>
97<li class="toctree-l1"><a class="reference internal" href="kerberos.html">Enabling Kerberos Authentication</a><ul>
98<li class="toctree-l2"><a class="reference internal" href="kerberos.html#keytab-file-for-http-service">Keytab file for HTTP Service</a></li>
99<li class="toctree-l2"><a class="reference internal" href="kerberos.html#apache-httpd-configuration">Apache HTTPD Configuration</a></li>
100<li class="toctree-l2"><a class="reference internal" href="kerberos.html#browser-settings-to-configure-kerberos-authentication">Browser settings to configure Kerberos Authentication</a></li>
101<li class="toctree-l2"><a class="reference internal" href="kerberos.html#postgresql-server-settings-to-configure-kerberos-authentication">PostgreSQL Server settings to configure Kerberos Authentication</a></li>
102<li class="toctree-l2"><a class="reference internal" href="kerberos.html#master-password">Master Password</a></li>
103</ul>
104</li>
105<li class="toctree-l1"><a class="reference internal" href="oauth2.html">Enabling OAUTH2 Authentication</a><ul>
106<li class="toctree-l2"><a class="reference internal" href="oauth2.html#redirect-url">Redirect URL</a></li>
107<li class="toctree-l2"><a class="reference internal" href="oauth2.html#master-password">Master Password</a></li>
108<li class="toctree-l2"><a class="reference internal" href="oauth2.html#login-page">Login Page</a></li>
109</ul>
110</li>
111<li class="toctree-l1"><a class="reference internal" href="webserver.html">Enabling Webserver Authentication</a><ul>
112<li class="toctree-l2"><a class="reference internal" href="webserver.html#master-password">Master Password</a></li>
113</ul>
114</li>
115</ul>
116</div>
117<div class="admonition note">
118<p class="admonition-title">Note</p>
119<p>Pre-compiled and configured installation packages are available for
120a number of platforms. These packages should be used by end-users whereever
121possible - the following information is useful for the maintainers of those
122packages and users interested in understanding how pgAdmin works.</p>
123</div>
124<p>The pgAdmin 4 client features a highly-customizable display that features
125drag-and-drop panels that you can arrange to make the best use of your desktop
126environment.</p>
127<p>The tree control provides an elegant overview of the managed servers, and the
128objects that reside on each server. Right-click on a node within the tree control
129to access context-sensitive menus that provide quick access to management tasks
130for the selected object.</p>
131<p>The tabbed browser provide quick access to statistical information about each
132object in the tree control, and pgAdmin tools and utilities (such as the Query
133tool and the debugger). pgAdmin opens additional feature tabs each time you
134access the extended functionality offered by pgAdmin tools; you can open, close,
135and re-arrange feature tabs as needed.</p>
136<p>Use the <em>Preferences</em> dialog to customize the content and behaviour of the pgAdmin
137display. To open the <em>Preferences</em> dialog, select <em>Preferences</em> from the <em>File</em> menu.</p>
138<p><em>Help</em> buttons in the lower-left corner of each dialog will open the online help
139for the dialog. You can access additional Postgres help by navigating through
140the <em>Help</em> menu, and selecting the name of the resource that you wish to open.</p>
141<p>You can search for objects in the database using the <a class="reference internal" href="search_objects.html#search-objects"><span class="std std-ref">Search objects</span></a></p>
142<div class="toctree-wrapper compound">
143<ul>
144<li class="toctree-l1"><a class="reference internal" href="user_interface.html">User Interface</a></li>
145<li class="toctree-l1"><a class="reference internal" href="menu_bar.html">Menu Bar</a><ul>
146<li class="toctree-l2"><a class="reference internal" href="menu_bar.html#the-file-menu">The File Menu</a></li>
147<li class="toctree-l2"><a class="reference internal" href="menu_bar.html#the-object-menu">The Object Menu</a></li>
148<li class="toctree-l2"><a class="reference internal" href="menu_bar.html#the-tools-menu">The Tools Menu</a></li>
149<li class="toctree-l2"><a class="reference internal" href="menu_bar.html#the-help-menu">The Help Menu</a></li>
150</ul>
151</li>
152<li class="toctree-l1"><a class="reference internal" href="toolbar.html">Toolbar</a></li>
153<li class="toctree-l1"><a class="reference internal" href="tabbed_browser.html">Tabbed Browser</a></li>
154<li class="toctree-l1"><a class="reference internal" href="tree_control.html">Tree Control</a></li>
155<li class="toctree-l1"><a class="reference internal" href="preferences.html">Preferences Dialog</a><ul>
156<li class="toctree-l2"><a class="reference internal" href="preferences.html#the-browser-node">The Browser Node</a></li>
157<li class="toctree-l2"><a class="reference internal" href="preferences.html#the-dashboards-node">The Dashboards Node</a></li>
158<li class="toctree-l2"><a class="reference internal" href="preferences.html#the-debugger-node">The Debugger Node</a></li>
159<li class="toctree-l2"><a class="reference internal" href="preferences.html#the-erd-tool-node">The ERD Tool Node</a></li>
160<li class="toctree-l2"><a class="reference internal" href="preferences.html#the-graphs-node">The Graphs Node</a></li>
161<li class="toctree-l2"><a class="reference internal" href="preferences.html#the-miscellaneous-node">The Miscellaneous Node</a></li>
162<li class="toctree-l2"><a class="reference internal" href="preferences.html#the-paths-node">The Paths Node</a></li>
163<li class="toctree-l2"><a class="reference internal" href="preferences.html#the-query-tool-node">The Query Tool Node</a></li>
164<li class="toctree-l2"><a class="reference internal" href="preferences.html#the-schema-diff-node">The Schema Diff Node</a></li>
165<li class="toctree-l2"><a class="reference internal" href="preferences.html#the-storage-node">The Storage Node</a></li>
166<li class="toctree-l2"><a class="reference internal" href="preferences.html#manage-preferences">Manage Preferences</a></li>
167<li class="toctree-l2"><a class="reference internal" href="preferences.html#get-preferences">Get Preferences</a></li>
168<li class="toctree-l2"><a class="reference internal" href="preferences.html#save-preferences">Save Preferences</a></li>
169<li class="toctree-l2"><a class="reference internal" href="preferences.html#updating-preferences-preferences-json">Updating Preferences preferences.json</a></li>
170<li class="toctree-l2"><a class="reference internal" href="preferences.html#json-format">JSON format</a></li>
171</ul>
172</li>
173<li class="toctree-l1"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts:</a><ul>
174<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html#main-browser-window">Main Browser Window</a></li>
175<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html#property-grid-controls">Property Grid Controls</a></li>
176<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html#sql-editors">SQL Editors</a></li>
177<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html#query-tool">Query Tool</a></li>
178<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html#debugger">Debugger</a></li>
179<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html#erd-tool">ERD Tool</a></li>
180<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html#inner-tab-and-panel-navigation">Inner Tab and Panel Navigation</a></li>
181<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html#access-key">Access Key</a></li>
182</ul>
183</li>
184<li class="toctree-l1"><a class="reference internal" href="search_objects.html">Search objects</a></li>
185</ul>
186</div>
187<p>Before using pgAdmin to manage objects that reside on a server, you must define a
188connection to the server; for more information please see <em>Connecting to a Server</em>
189in the next section.</p>
190</section>
191
192
193 <div class="clearer"></div>
194 </div>
195 </div>
196 </div>
197 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
198 <div class="sphinxsidebarwrapper">
199<h3><a href="index.html">Table of Contents</a></h3>
200<ul class="current">
201<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting Started</a><ul>
202<li class="toctree-l2"><a class="reference internal" href="deployment.html">Deployment</a></li>
203<li class="toctree-l2"><a class="reference internal" href="login.html">Login Page</a></li>
204<li class="toctree-l2"><a class="reference internal" href="mfa.html">Enabling two-factor authentication (2FA)</a></li>
205<li class="toctree-l2"><a class="reference internal" href="user_management.html">User Management Dialog</a></li>
206<li class="toctree-l2"><a class="reference internal" href="change_ownership.html">Change Ownership Dialog</a></li>
207<li class="toctree-l2"><a class="reference internal" href="change_user_password.html">Change User Password Dialog</a></li>
208<li class="toctree-l2"><a class="reference internal" href="restore_locked_user.html">Lock/Restore Account</a></li>
209<li class="toctree-l2"><a class="reference internal" href="ldap.html">Enabling LDAP Authentication</a></li>
210<li class="toctree-l2"><a class="reference internal" href="kerberos.html">Enabling Kerberos Authentication</a></li>
211<li class="toctree-l2"><a class="reference internal" href="oauth2.html">Enabling OAUTH2 Authentication</a></li>
212<li class="toctree-l2"><a class="reference internal" href="webserver.html">Enabling Webserver Authentication</a></li>
213<li class="toctree-l2"><a class="reference internal" href="user_interface.html">User Interface</a></li>
214<li class="toctree-l2"><a class="reference internal" href="menu_bar.html">Menu Bar</a></li>
215<li class="toctree-l2"><a class="reference internal" href="toolbar.html">Toolbar</a></li>
216<li class="toctree-l2"><a class="reference internal" href="tabbed_browser.html">Tabbed Browser</a></li>
217<li class="toctree-l2"><a class="reference internal" href="tree_control.html">Tree Control</a></li>
218<li class="toctree-l2"><a class="reference internal" href="preferences.html">Preferences Dialog</a></li>
219<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts:</a></li>
220<li class="toctree-l2"><a class="reference internal" href="search_objects.html">Search objects</a></li>
221</ul>
222</li>
223<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
224<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
225<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
226<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
227<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
228<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
229<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
230<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
231<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
232<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
233<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
234<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
235<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
236</ul>
237
238<search id="searchbox" style="display: none" role="search">
239 <h3 id="searchlabel">Quick search</h3>
240 <div class="searchformwrapper">
241 <form class="search" action="search.html" method="get">
242 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
243 <input type="submit" value="Go" />
244 </form>
245 </div>
246</search>
247<script>document.getElementById('searchbox').style.display = "block"</script>
248 </div>
249<div id="sidebarbutton" title="Collapse sidebar">
250<span>«</span>
251</div>
252
253 </div>
254 <div class="clearer"></div>
255 </div>
256 <div class="related" role="navigation" aria-label="related navigation">
257 <h3>Navigation</h3>
258 <ul>
259 <li class="right" style="margin-right: 10px">
260 <a href="genindex.html" title="General Index"
261 >index</a></li>
262 <li class="right" >
263 <a href="deployment.html" title="Deployment"
264 >next</a> |</li>
265 <li class="right" >
266 <a href="index.html" title="pgAdmin 4"
267 >previous</a> |</li>
268 <li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
269 <li class="nav-item nav-item-this"><a href="">Getting Started</a></li>
270 </ul>
271 </div>
272 <div class="footer" role="contentinfo">
273 <div class="related" role="navigation" aria-label="related navigation">
274 <ul>
275 <li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
276 <li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
277 <li class="right" ><a href="deployment.html" title="Deployment" accesskey="N">next</a> |</li>
278 <li class="right" ><a href="index.html" title="pgAdmin 4" accesskey="P">previous</a> |</li>
279 </ul>
280 </div>
281 </div>
282 </body>
283</html>