Team Ai
Datasetpublic

codekingpro/portable-devtools

sourceHugging Faceupdated 5mo agoView on Hugging Face
1likes14kdownloads
server_dialog.html343 linesDownload Raw Back to html
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>Server Dialog &#8212; 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="Clear Saved Passwords" href="clear_saved_passwords.html" />
23    <link rel="prev" title="Server Group Dialog" href="server_group_dialog.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="clear_saved_passwords.html" title="Clear Saved Passwords"
33             accesskey="N">next</a> |</li>
34        <li class="right" >
35          <a href="server_group_dialog.html" title="Server Group Dialog"
36             accesskey="P">previous</a> |</li>
37        <li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> &#187;</li>
38          <li class="nav-item nav-item-1"><a href="connecting.html" accesskey="U">Connecting To A Server</a> &#187;</li>
39        <li class="nav-item nav-item-this"><a href="">Server Dialog</a></li> 
40      </ul>
41    </div>  
42
43    <div class="document">
44      <div class="documentwrapper">
45        <div class="bodywrapper">
46          <div class="body" role="main">
47            
48  <section id="server-dialog">
49<span id="id1"></span><h1><span class="target" id="index-0"></span>Server Dialog<a class="headerlink" href="#server-dialog" title="Link to this heading">¶</a></h1>
50<p>Use the <em>Server</em> dialog to describe a connection to a server. Note: you must
51ensure that the pg_hba.conf file of the server from which you are connecting
52allows connections from the host of the client.</p>
53<img alt="Server dialog general tab" class="align-center" src="_images/server_general.png" />
54<p>Use the fields in the <em>General</em> tab to identify the server:</p>
55<ul>
56<li><p>Use the <em>Name</em> field to add a descriptive name for the server; the name
57specified will be displayed in the <em>Object Explorer</em>.</p></li>
58<li><p>Use the drop-down list box in the <em>Server group</em> field to select the parent
59node for the server; the server will be displayed in the <em>Object Explorer</em>
60control within the specified group.</p></li>
61<li><p>Use the color-picker in the <em>Background</em> field to specify the background
62color for the server.</p></li>
63<li><p>Use the color-picker in the <em>Foreground</em> field to specify the foreground
64color for the server.</p></li>
65<li><p>If the <em>Connect now?</em> checkbox is checked, the client will attempt a
66connection to the server upon completion of the dialog; this is the default</p></li>
67<li><p>If the <em>Shared?</em> switch is moved to <em>Yes</em> then that server can be
68shared with all the other users. This option is available only to admin users.
69For more information on users see <a class="reference internal" href="user_management.html#user-management"><span class="std std-ref">User Management Dialog</span></a>.
70Users can access the shared servers with some restrictions - the following
71operations on shared servers are not permitted:</p>
72<blockquote>
73<div><ul class="simple">
74<li><p>Delete the server</p></li>
75<li><p>Rename the server</p></li>
76<li><p>Rename the group server</p></li>
77<li><p>Change of host, port, and maintenance database</p></li>
78</ul>
79</div></blockquote>
80<p>Please note that once the server is shared, it’s icon is changed in the
81object explorer.</p>
82</li>
83<li><p>Use the <em>Shared Username</em> field to fill the username of the shared server
84connection. By default, it will take the username of the server being shared.</p></li>
85<li><p>Provide a comment about the server in the <em>Comments</em> field.</p></li>
86</ul>
87<p>Click the <em>Connection</em> tab to continue.</p>
88<img alt="Server dialog connection tab" class="align-center" src="_images/server_connection.png" />
89<p>Use the fields in the <em>Connection</em> tab to configure a connection:</p>
90<ul class="simple">
91<li><p>Specify the IP address of the server host, or the fully qualified domain
92name in the <em>Host name/address</em> field. If you provide a unix domain socket,
93the directory name must begin with a “/”.</p></li>
94<li><p>Enter the listener port number of the server host in the <em>Port</em> field. The
95default is <em>5432</em>.</p></li>
96<li><p>Use the <em>Maintenance database</em> field to specify the name of the initial
97database to which the client will connect. If you will be using pgAgent or
98adminpack objects, the pgAgent schema and adminpack objects should be
99installed on that database.</p></li>
100<li><p>Use the <em>Username</em> field to specify the name of a role that will be used when
101authenticating with the server.</p></li>
102<li><p>When <em>Kerberos authentication?</em> is set to <em>True</em>, pgAdmin will try to connect
103the PostgreSQL server using Kerberos authentication.</p></li>
104<li><p>Use the <em>Password</em> field to provide a password that will be supplied when
105authenticating with the server.</p></li>
106<li><p>Check the box next to <em>Save password?</em> to instruct pgAdmin to save the
107password for future use. Use
108<a class="reference internal" href="clear_saved_passwords.html#clear-saved-passwords"><span class="std std-ref">Clear Saved Password</span></a> to remove the saved
109password.</p></li>
110<li><p>Use the <em>Role</em> field to specify the name of a role that has privileges that
111will be conveyed to the client after authentication with the server. This
112selection allows you to connect as one role, and then assume the permissions
113of this specified role after the connection is established. Note that the
114connecting role must be a member of the role specified.</p></li>
115<li><p>Use the <em>Service</em> field to specify the service name. For more information,
116see
117<a class="reference external" href="https://www.postgresql.org/docs/current/libpq-pgservice.html">Section 33.16 of the Postgres documentation</a>.</p></li>
118</ul>
119<p>Click the <em>Parameters</em> tab to continue.</p>
120<img alt="Server dialog ssl tab" class="align-center" src="_images/server_parameters.png" />
121<p>Use the fields in the <em>Parameters</em> tab to configure a connection:</p>
122<p>Click on the <em>+</em> button to add a new parameter. Some of the parameters are:</p>
123<ul class="simple">
124<li><p><em>Host address</em> using this field to specify the host IP address may save time
125by avoiding a DNS lookup on connection, but it may be useful to specify both
126a host name and address when using Kerberos, GSSAPI, or SSPI authentication
127methods, as well as for verify-full SSL certificate verification.</p></li>
128<li><p><em>Password File</em> field to specify the location of a password file
129(.pgpass). A .pgpass file allows a user to login without providing a password
130when they connect.  For more information, see
131<a class="reference external" href="https://www.postgresql.org/docs/current/libpq-pgpass.html">Section 33.15 of the Postgres documentation</a>.</p></li>
132<li><p><em>Connection timeout</em> field to specify the maximum wait for connection,
133in seconds. Zero or not specified means wait indefinitely. It is not
134recommended to use a timeout of less than 2 seconds. By default it is set to
13510 seconds.</p></li>
136<li><p><em>SSL mode</em> field to select the type of SSL connection the server should use.
137For more information about using SSL encryption, see
138<a class="reference external" href="https://www.postgresql.org/docs/current/libpq-ssl.html">Section 33.18 of the Postgres documentation</a>.</p></li>
139</ul>
140<p>If pgAdmin is installed in Server mode (the default mode), you can use the
141platform-specific File manager dialog to upload files that support SSL
142encryption to the server.  To access the File manager dialog, click the
143icon that is located to the right of each of the following fields.</p>
144<ul class="simple">
145<li><p><em>Client certificate</em> field to specify the file containing the client
146SSL certificate.  This file will replace the default
147<em>~/.postgresql/postgresql.crt</em> if pgAdmin is installed in Desktop mode, and
148<em>&lt;STORAGE_DIR&gt;/&lt;USERNAME&gt;/.postgresql/postgresql.crt</em> if pgAdmin is installed
149in Web mode. This parameter is ignored if an SSL connection is not made.</p></li>
150<li><p><em>Client certificate key</em> field to specify the file containing the
151secret key used for the client certificate.  This file will replace the
152default <em>~/.postgresql/postgresql.key</em> if pgAdmin is installed in Desktop
153mode, and <em>&lt;STORAGE_DIR&gt;/&lt;USERNAME&gt;/.postgresql/postgresql.key</em> if pgAdmin
154is installed in Web mode. This parameter is ignored if an SSL connection is
155not made.</p></li>
156<li><p><em>Root certificate</em> field to specify the file containing the SSL
157certificate authority.  This file will replace the default
158<em>~/.postgresql/root.crt</em>. This parameter is ignored if an SSL connection is
159not made.</p></li>
160<li><p><em>Certificate revocation list</em> field to specify the file containing
161the SSL certificate revocation list.  This list will replace the default list,
162found in <em>~/.postgresql/root.crl</em>. This parameter is ignored if an SSL
163connection is not made.</p></li>
164<li><p><em>SSL compression?</em> is set to <em>True</em>, data sent over SSL connections will
165be compressed.  The default value is <em>False</em> (compression is disabled). This
166parameter is ignored if an SSL connection is not made.</p></li>
167</ul>
168<div class="admonition warning">
169<p class="admonition-title">Warning</p>
170<p>In Server mode, certificates, private keys, and the revocation list
171are stored in the per-user file storage area on the server, which is owned
172by the user account under which the pgAdmin server process is run. This
173means that administrators of the server may be able to access those files;
174appropriate caution should be taken before choosing to use this feature.</p>
175</div>
176<p>Click the <em>SSH Tunnel</em> tab to continue.</p>
177<img alt="Server dialog ssh tunnel tab" class="align-center" src="_images/server_ssh_tunnel.png" />
178<p>Use the fields in the <em>SSH Tunnel</em> tab to configure SSH Tunneling:</p>
179<p>You can use the “SSH Tunnel” tab to connect pgAdmin (through an intermediary
180proxy host) to a server that resides on a network to which the client may
181not be able to connect directly.</p>
182<ul>
183<li><p>Set “Use SSH tunneling” to <em>Yes</em> to specify that pgAdmin should use an SSH
184tunnel when connecting to the specified server.</p></li>
185<li><p>Specify the name or IP address of the SSH host (through which client
186connections will be forwarded) in the <em>Tunnel host</em> field.</p></li>
187<li><p>Specify the port of the SSH host (through which client connections will be
188forwarded) in the <em>Tunnel port</em> field.</p></li>
189<li><p>Specify the name of a user with login privileges for the SSH host in the
190<em>Username</em> field.</p></li>
191<li><p>Specify the type of authentication that will be used when connecting to the
192SSH host in the <em>Authentication</em> field:</p>
193<blockquote>
194<div><ul class="simple">
195<li><p>Select the <em>Password</em> option to specify that pgAdmin will use a password
196for authentication to the SSH host. This is the default.</p></li>
197<li><p>Select the <em>Identity file</em> to specify that pgAdmin will use a private key
198file when connecting.</p></li>
199</ul>
200</div></blockquote>
201</li>
202<li><p>If the SSH host is expecting a private key file for authentication, use the
203<em>Identity file</em> field to specify the location of the key file.</p></li>
204<li><p>If the SSH host is expecting a password of the user name or an identity file
205if being used, use the <em>Password</em> field to specify the password.</p></li>
206<li><p>Check the box next to <em>Save password?</em> to instruct pgAdmin to save the
207password for future use. Use
208<a class="reference internal" href="clear_saved_passwords.html#clear-saved-passwords"><span class="std std-ref">Clear SSH Tunnel Password</span></a> to remove the saved
209password.</p></li>
210<li><p>Use the <em>Keep alive</em> field to specify interval in seconds defining the period
211in which, if no data was sent over the connection, a ‘keepalive’ packet will
212be sent (and ignored by the remote host). This can be useful to keep
213connections alive over a NAT. You can set to 0 for disable keepalive.</p></li>
214</ul>
215<p>Click the <em>Advanced</em> tab to continue.</p>
216<img alt="Server dialog advanced tab" class="align-center" src="_images/server_advanced.png" />
217<p>Use the fields in the <em>Advanced</em> tab to configure a connection:</p>
218<ul class="simple">
219<li><p>Use the <em>DB restriction</em> field to provide a SQL restriction that will be used
220against the pg_database table to limit the databases that you see. For
221example, you might enter: <em>live_db test_db</em> so that only live_db and test_db
222are shown in the pgAdmin browser. Separate entries with a comma or tab as you
223type.</p></li>
224<li><p>Use the <em>Password exec command</em> field to specify a shell command to be executed
225to retrieve a password to be used for SQL authentication. The <code class="docutils literal notranslate"><span class="pre">stdout</span></code> of the
226command will be used as the SQL password. This may be useful when the password
227should be generated as a transient authorization token instead of providing a
228password when connecting in <a class="reference external" href="https://www.postgresql.org/docs/current/auth-pam.html">PAM authentication</a> scenarios.</p></li>
229<li><p>Use the <em>Password exec expiration</em> field to specify a maximum age, in seconds,
230of the password generated with a <em>Password exec command</em>. If not specified,
231the password will not expire until your pgAdmin session does.
232Zero means the command will be executed for each new connection or reconnection that is made.
233If the generated password is not valid indefinitely, set this value to slightly before it will expire.</p></li>
234<li><p>Use the <em>Prepare threshold</em> field to specify the number of times a query is
235executed before it is prepared. If it is set to 0, every query is prepared
236the first time it is executed. If it is set to blank, prepared statements are disabled
237on the connection. This is particularly useful with external connection poolers,
238such as PgBouncer, which is not compatible with prepared statements. Set this to
239blank in such cases.</p></li>
240</ul>
241<div class="admonition note">
242<p class="admonition-title">Note</p>
243<p>The password file option is only supported when pgAdmin is using libpq
244v10.0 or later to connect to the server.</p>
245</div>
246<div class="admonition note">
247<p class="admonition-title">Note</p>
248<p>The Password exec option is only supported when pgAdmin is run in desktop mode.</p>
249</div>
250<ul class="simple">
251<li><p>Click the <em>Save</em> button to save your work.</p></li>
252<li><p>Click the <em>Close</em> button to exit without saving your work.</p></li>
253<li><p>Click the <em>Reset</em> button to return the values specified on the Server dialog
254to their original condition.</p></li>
255</ul>
256<div class="toctree-wrapper compound">
257<ul>
258<li class="toctree-l1"><a class="reference internal" href="clear_saved_passwords.html">Clear Saved Passwords</a></li>
259</ul>
260</div>
261</section>
262
263
264            <div class="clearer"></div>
265          </div>
266        </div>
267      </div>
268      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
269        <div class="sphinxsidebarwrapper">
270<h3><a href="index.html">Table of Contents</a></h3>
271<ul class="current">
272<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
273<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
274<li class="toctree-l1 current"><a class="reference internal" href="connecting.html">Connecting To A Server</a><ul class="current">
275<li class="toctree-l2"><a class="reference internal" href="server_group_dialog.html">Server Group Dialog</a></li>
276<li class="toctree-l2 current"><a class="current reference internal" href="#">Server Dialog</a></li>
277<li class="toctree-l2"><a class="reference internal" href="cloud_deployment.html">PostgreSQL Cloud Deployment</a></li>
278<li class="toctree-l2"><a class="reference internal" href="master_password.html">Master Password</a></li>
279<li class="toctree-l2"><a class="reference internal" href="connect_to_server.html">Connect to Server</a></li>
280<li class="toctree-l2"><a class="reference internal" href="connect_error.html">Connection Error</a></li>
281<li class="toctree-l2"><a class="reference internal" href="import_export_servers.html">Import/Export Servers</a></li>
282</ul>
283</li>
284<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
285<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
286<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
287<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
288<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
289<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
290<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
291<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
292<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
293<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
294<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
295</ul>
296
297<search id="searchbox" style="display: none" role="search">
298  <h3 id="searchlabel">Quick search</h3>
299    <div class="searchformwrapper">
300    <form class="search" action="search.html" method="get">
301      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
302      <input type="submit" value="Go" />
303    </form>
304    </div>
305</search>
306<script>document.getElementById('searchbox').style.display = "block"</script>
307        </div>
308<div id="sidebarbutton" title="Collapse sidebar">
309<span>«</span>
310</div>
311
312      </div>
313      <div class="clearer"></div>
314    </div>
315    <div class="related" role="navigation" aria-label="related navigation">
316      <h3>Navigation</h3>
317      <ul>
318        <li class="right" style="margin-right: 10px">
319          <a href="genindex.html" title="General Index"
320             >index</a></li>
321        <li class="right" >
322          <a href="clear_saved_passwords.html" title="Clear Saved Passwords"
323             >next</a> |</li>
324        <li class="right" >
325          <a href="server_group_dialog.html" title="Server Group Dialog"
326             >previous</a> |</li>
327        <li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> &#187;</li>
328          <li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> &#187;</li>
329        <li class="nav-item nav-item-this"><a href="">Server Dialog</a></li> 
330      </ul>
331    </div>
332    <div class="footer" role="contentinfo">
333        <div class="related" role="navigation" aria-label="related navigation">
334          <ul>
335              <li class="left" style="margin-left: 10px">&#169; Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
336            <li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
337            <li class="right" ><a href="clear_saved_passwords.html" title="Clear Saved Passwords" accesskey="N">next</a> |</li>
338            <li class="right" ><a href="server_group_dialog.html" title="Server Group Dialog" accesskey="P">previous</a> |</li>
339          </ul>
340        </div>
341    </div>
342  </body>
343</html>
codekingpro/portable-devtools · Team Ai