codekingpro/portable-devtools

1����sphinx.addnodes��document���)��}�(�	rawsource����children�]�(�docutils.nodes��target���)��}�(h�.. _server_dialog:�h]��2attributes�}�(�ids�]��classes�]��names�]��dupnames�]��backrefs�]��refid��
server-dialog�u�tagname�h3�line�K
�parent�h�	_document�h�source��hD:\a\pgadmin-packaging-foundation\pgadmin-packaging-foundation\pgadmin4-8.6\docs\en_US\server_dialog.rst�ubh	�section���)��}�(hhh]�(h	�title���)��}�(h�`Server Dialog`:index:�h]�(h�index���)��}�(hhh]�h}�(h]�h]�h]�h]�h]��entries�]�(�single��
Server Dialog��index-0�hNt�auhh/h"h#hKh h+ubh)��}�(hhh]�h}�(h]�h>ah]�h]�h]�h]�uhh4h h+ubh	�Text����
Server Dialog�����}�(h h+h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhh)h h&h!hh"h#hKubh	�	paragraph���)��}�(h��Use the *Server* dialog to describe a connection to a server. Note: you must5ensure that the pg_hba.conf file of the server from which you are connecting6allows connections from the host of the client.�h]�(hJ�Use the �����}�(h hWh!hh"NhNubh	�emphasis���)��}�(h�*Server*�h]�hJ�Server�����}�(h hah!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h hWubhJ�� dialog to describe a connection to a server. Note: you must7ensure that the pg_hba.conf file of the server from which you are connecting8allows connections from the host of the client.�����}�(h hWh!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKh h&h!hubh	�image���)��}�(h�\.. image:: images/server_general.png9    :alt: Server dialog general tab10    :align: center11�h]�h}�(h]�h]�h]�h]�h]��alt��Server dialog general tab��align��center��uri��images/server_general.png��12candidates�}��
*�h�suhhyh"h#hKh h&h!hubhV)��}�(h�;Use the fields in the *General* tab to identify the server:�h]�(hJ�Use the fields in the �����}�(h h�h!hh"NhNubh`)��}�(h�	*General*�h]�hJ�General�����}�(h h�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h h�ubhJ� tab to identify the server:�����}�(h h�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKh h&h!hubh	�bullet_list���)��}�(hhh]�(h	�	list_item���)��}�(h�~Use the *Name* field to add a descriptive name for the server; the name13specified will be displayed in the *Object Explorer*.14�h]�hV)��}�(h�}Use the *Name* field to add a descriptive name for the server; the name15specified will be displayed in the *Object Explorer*.�h]�(hJ�Use the �����}�(h h�h!hh"NhNubh`)��}�(h�*Name*�h]�hJ�Name�����}�(h h�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h h�ubhJ�] field to add a descriptive name for the server; the name16specified will be displayed in the �����}�(h h�h!hh"NhNubh`)��}�(h�*Object Explorer*�h]�hJ�Object Explorer�����}�(h h�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h h�ubhJ�
.�����}�(h h�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKh h�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKh h�h!hubh�)��}�(h��Use the drop-down list box in the *Server group* field to select the parent17node for the server; the server will be displayed in the *Object Explorer*18control within the specified group.19�h]�hV)��}�(h��Use the drop-down list box in the *Server group* field to select the parent20node for the server; the server will be displayed in the *Object Explorer*21control within the specified group.�h]�(hJ�"Use the drop-down list box in the �����}�(h h�h!hh"NhNubh`)��}�(h�*Server group*�h]�hJ�Server group�����}�(h h�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h h�ubhJ�U field to select the parent22node for the server; the server will be displayed in the �����}�(h h�h!hh"NhNubh`)��}�(h�*Object Explorer*�h]�hJ�Object Explorer�����}�(h j
h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h h�ubhJ�$23control within the specified group.�����}�(h h�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKh h�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKh h�h!hubh�)��}�(h�_Use the color-picker in the *Background* field to specify the background24color for the server.25�h]�hV)��}�(h�^Use the color-picker in the *Background* field to specify the background26color for the server.�h]�(hJ�Use the color-picker in the �����}�(h j1
h!hh"NhNubh`)��}�(h�*Background*�h]�hJ�27Background�����}�(h j9
h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j1
ubhJ�6 field to specify the background28color for the server.�����}�(h j1
h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKh j-
ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKh h�h!hubh�)��}�(h�_Use the color-picker in the *Foreground* field to specify the foreground29color for the server.30�h]�hV)��}�(h�^Use the color-picker in the *Foreground* field to specify the foreground31color for the server.�h]�(hJ�Use the color-picker in the �����}�(h j[
h!hh"NhNubh`)��}�(h�*Foreground*�h]�hJ�32Foreground�����}�(h jc
h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j[
ubhJ�6 field to specify the foreground33color for the server.�����}�(h j[
h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKh jW
ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKh h�h!hubh�)��}�(h��If the *Connect now?* checkbox is checked, the client will attempt a34connection to the server upon completion of the dialog; this is the default35�h]�hV)��}�(h��If the *Connect now?* checkbox is checked, the client will attempt a36connection to the server upon completion of the dialog; this is the default�h]�(hJ�If the �����}�(h j�
h!hh"NhNubh`)��}�(h�*Connect now?*�h]�hJ�Connect now?�����}�(h j�
h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�
ubhJ�{ checkbox is checked, the client will attempt a37connection to the server upon completion of the dialog; this is the default�����}�(h j�
h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKh j�
ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKh h�h!hubh�)��}�(hX5If the *Shared?* switch is moved to *Yes* then that server can be38shared with all the other users. This option is available only to admin users.39For more information on users see :ref:`User Management Dialog <user_management>`.40Users can access the shared servers with some restrictions - the following41operations on shared servers are not permitted:42 43  * Delete the server44  * Rename the server45  * Rename the group server46  * Change of host, port, and maintenance database47 48Please note that once the server is shared, it's icon is changed in the49object explorer.50�h]�(hV)��}�(hX^
If the *Shared?* switch is moved to *Yes* then that server can be51shared with all the other users. This option is available only to admin users.52For more information on users see :ref:`User Management Dialog <user_management>`.53Users can access the shared servers with some restrictions - the following54operations on shared servers are not permitted:�h]�(hJ�If the �����}�(h j�
h!hh"NhNubh`)��}�(h�	*Shared?*�h]�hJ�Shared?�����}�(h j�
h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�
ubhJ� switch is moved to �����}�(h j�
h!hh"NhNubh`)��}�(h�*Yes*�h]�hJ�Yes�����}�(h j�
h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�
ubhJ�� then that server can be55shared with all the other users. This option is available only to admin users.56For more information on users see �����}�(h j�
h!hh"NhNubh�pending_xref���)��}�(h�/:ref:`User Management Dialog <user_management>`�h]�h	�inline���)��}�(hj�
h]�hJ�User Management Dialog�����}�(h j�
h!hh"NhNubah}�(h]�h]�(�xref��std��std-ref�eh]�h]�h]�uhj�
h j�
ubah}�(h]�h]�h]�h]�h]��refdoc��
server_dialog��	refdomain�j�
�reftype��ref��refexplicit���refwarn���	reftarget��user_management�uhj�
h"h#hK!h j�
ubhJ�|.57Users can access the shared servers with some restrictions - the following58operations on shared servers are not permitted:�����}�(h j�
h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK!h j�
ubh	�block_quote���)��}�(h�s* Delete the server59* Rename the server60* Rename the group server61* Change of host, port, and maintenance database62�h]�h�)��}�(hhh]�(h�)��}�(h�Delete the server�h]�hV)��}�(hjh]�hJ�Delete the server�����}�(h jh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhhUh"h#hK'h jubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK'h jubh�)��}�(h�Rename the server�h]�hV)��}�(hj.h]�hJ�Rename the server�����}�(h j0h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhhUh"h#hK(h j,ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK(h jubh�)��}�(h�Rename the group server�h]�hV)��}�(hjEh]�hJ�Rename the group server�����}�(h jGh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhhUh"h#hK)h jCubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK)h jubh�)��}�(h�/Change of host, port, and maintenance database63�h]�hV)��}�(h�.Change of host, port, and maintenance database�h]�hJ�.Change of host, port, and maintenance database�����}�(h j^h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhhUh"h#hK*h jZubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK*h jubeh}�(h]�h]�h]�h]�h]��bullet�h�uhh�h"h#hK'h jubah}�(h]�h]�h]�h]�h]�uhjh"h#hK'h j�
ubhV)��}�(h�XPlease note that once the server is shared, it's icon is changed in the64object explorer.�h]�hJ�ZPlease note that once the server is shared, it’s icon is changed in the65object explorer.�����}�(h jh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhhUh"h#hK,h j�
ubeh}�(h]�h]�h]�h]�h]�uhh�h"h#hK!h h�h!hubh�)��}�(h��Use the *Shared Username* field to fill the username of the shared server66connection. By default, it will take the username of the server being shared.67�h]�hV)��}�(h��Use the *Shared Username* field to fill the username of the shared server68connection. By default, it will take the username of the server being shared.�h]�(hJ�Use the �����}�(h j�h!hh"NhNubh`)��}�(h�*Shared Username*�h]�hJ�Shared Username�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�~ field to fill the username of the shared server69connection. By default, it will take the username of the server being shared.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK/h j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK/h h�h!hubh�)��}�(h�<Provide a comment about the server in the *Comments* field.70�h]�hV)��}�(h�;Provide a comment about the server in the *Comments* field.�h]�(hJ�*Provide a comment about the server in the �����}�(h j�h!hh"NhNubh`)��}�(h�71*Comments*�h]�hJ�Comments�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ� field.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK2h j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK2h h�h!hubeh}�(h]�h]�h]�h]�h]�jxh�uhh�h"h#hKh h&h!hubhV)��}�(h�'Click the *Connection* tab to continue.�h]�(hJ�72Click the �����}�(h j�h!hh"NhNubh`)��}�(h�*Connection*�h]�hJ�73Connection�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ� tab to continue.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK4h h&h!hubhz)��}�(h�b.. image:: images/server_connection.png74    :alt: Server dialog connection tab75    :align: center76�h]�h}�(h]�h]�h]�h]�h]��alt��Server dialog connection tab��align��center��uri��images/server_connection.png�h�}�h�jsuhhyh"h#hK6h h&h!hubhV)��}�(h�AUse the fields in the *Connection* tab to configure a connection:�h]�(hJ�Use the fields in the �����}�(h jh!hh"NhNubh`)��}�(h�*Connection*�h]�hJ�77Connection�����}�(h j&h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jubhJ� tab to configure a connection:�����}�(h jh!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK:h h&h!hubh�)��}�(hhh]�(h�)��}�(h��Specify the IP address of the server host, or the fully qualified domain78name in the *Host name/address* field. If you provide a unix domain socket,79the directory name must begin with a "/".�h]�hV)��}�(h��Specify the IP address of the server host, or the fully qualified domain80name in the *Host name/address* field. If you provide a unix domain socket,81the directory name must begin with a "/".�h]�(hJ�USpecify the IP address of the server host, or the fully qualified domain82name in the �����}�(h jEh!hh"NhNubh`)��}�(h�*Host name/address*�h]�hJ�Host name/address�����}�(h jMh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jEubhJ�Z field. If you provide a unix domain socket,83the directory name must begin with a “/”.�����}�(h jEh!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK<h jAubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK<h j>h!hubh�)��}�(h�]Enter the listener port number of the server host in the *Port* field. The84default is *5432*.�h]�hV)��}�(h�]Enter the listener port number of the server host in the *Port* field. The85default is *5432*.�h]�(hJ�9Enter the listener port number of the server host in the �����}�(h joh!hh"NhNubh`)��}�(h�*Port*�h]�hJ�Port�����}�(h jwh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h joubhJ� field. The86default is �����}�(h joh!hh"NhNubh`)��}�(h�*5432*�h]�hJ�5432�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h joubhJ�
.�����}�(h joh!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK?h jkubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK?h j>h!hubh�)��}�(h��Use the *Maintenance database* field to specify the name of the initial87database to which the client will connect. If you will be using pgAgent or88adminpack objects, the pgAgent schema and adminpack objects should be89installed on that database.�h]�hV)��}�(h��Use the *Maintenance database* field to specify the name of the initial90database to which the client will connect. If you will be using pgAgent or91adminpack objects, the pgAgent schema and adminpack objects should be92installed on that database.�h]�(hJ�Use the �����}�(h j�h!hh"NhNubh`)��}�(h�*Maintenance database*�h]�hJ�Maintenance database�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�� field to specify the name of the initial93database to which the client will connect. If you will be using pgAgent or94adminpack objects, the pgAgent schema and adminpack objects should be95installed on that database.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKAh j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKAh j>h!hubh�)��}�(h�mUse the *Username* field to specify the name of a role that will be used when96authenticating with the server.�h]�hV)��}�(h�mUse the *Username* field to specify the name of a role that will be used when97authenticating with the server.�h]�(hJ�Use the �����}�(h j�h!hh"NhNubh`)��}�(h�98*Username*�h]�hJ�Username�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�[ field to specify the name of a role that will be used when99authenticating with the server.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKEh j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKEh j>h!hubh�)��}�(h��When *Kerberos authentication?* is set to *True*, pgAdmin will try to connect100the PostgreSQL server using Kerberos authentication.�h]�hV)��}�(h��When *Kerberos authentication?* is set to *True*, pgAdmin will try to connect101the PostgreSQL server using Kerberos authentication.�h]�(hJ�When �����}�(h j�h!hh"NhNubh`)��}�(h�*Kerberos authentication?*�h]�hJ�Kerberos authentication?�����}�(h jh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ� is set to �����}�(h j�h!hh"NhNubh`)��}�(h�*True*�h]�hJ�True�����}�(h jh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�R, pgAdmin will try to connect102the PostgreSQL server using Kerberos authentication.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKGh j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKGh j>h!hubh�)��}�(h�iUse the *Password* field to provide a password that will be supplied when103authenticating with the server.�h]�hV)��}�(h�iUse the *Password* field to provide a password that will be supplied when104authenticating with the server.�h]�(hJ�Use the �����}�(h j;h!hh"NhNubh`)��}�(h�105*Password*�h]�hJ�Password�����}�(h jCh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j;ubhJ�W field to provide a password that will be supplied when106authenticating with the server.�����}�(h j;h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKIh j7ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKIh j>h!hubh�)��}�(h��Check the box next to *Save password?* to instruct pgAdmin to save the107password for future use. Use108:ref:`Clear Saved Password <clear_saved_passwords>` to remove the saved109password.�h]�hV)��}�(h��Check the box next to *Save password?* to instruct pgAdmin to save the110password for future use. Use111:ref:`Clear Saved Password <clear_saved_passwords>` to remove the saved112password.�h]�(hJ�Check the box next to �����}�(h jeh!hh"NhNubh`)��}�(h�*Save password?*�h]�hJ�Save password?�����}�(h jmh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jeubhJ�> to instruct pgAdmin to save the113password for future use. Use114�����}�(h jeh!hh"NhNubj�
)��}�(h�3:ref:`Clear Saved Password <clear_saved_passwords>`�h]�j�
)��}�(hj�h]�hJ�Clear Saved Password�����}�(h j�h!hh"NhNubah}�(h]�h]�(j�
�std��std-ref�eh]�h]�h]�uhj�
h jubah}�(h]�h]�h]�h]�h]��refdoc�j�
�	refdomain�j��reftype��ref��refexplicit���refwarn��j�clear_saved_passwords�uhj�
h"h#hKKh jeubhJ� to remove the saved115password.�����}�(h jeh!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKKh jaubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKKh j>h!hubh�)��}�(hXd
Use the *Role* field to specify the name of a role that has privileges that116will be conveyed to the client after authentication with the server. This117selection allows you to connect as one role, and then assume the permissions118of this specified role after the connection is established. Note that the119connecting role must be a member of the role specified.�h]�hV)��}�(hXd
Use the *Role* field to specify the name of a role that has privileges that120will be conveyed to the client after authentication with the server. This121selection allows you to connect as one role, and then assume the permissions122of this specified role after the connection is established. Note that the123connecting role must be a member of the role specified.�h]�(hJ�Use the �����}�(h j�h!hh"NhNubh`)��}�(h�*Role*�h]�hJ�Role�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJXV
 field to specify the name of a role that has privileges that124will be conveyed to the client after authentication with the server. This125selection allows you to connect as one role, and then assume the permissions126of this specified role after the connection is established. Note that the127connecting role must be a member of the role specified.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKOh j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKOh j>h!hubh�)��}�(h��Use the *Service* field to specify the service name. For more information,128see129`Section 33.16 of the Postgres documentation <https://www.postgresql.org/docs/current/libpq-pgservice.html>`_.130�h]�hV)��}�(h��Use the *Service* field to specify the service name. For more information,131see132`Section 33.16 of the Postgres documentation <https://www.postgresql.org/docs/current/libpq-pgservice.html>`_.�h]�(hJ�Use the �����}�(h j�h!hh"NhNubh`)��}�(h�	*Service*�h]�hJ�Service�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�> field to specify the service name. For more information,133see134�����}�(h j�h!hh"NhNubh	�	reference���)��}�(h�m`Section 33.16 of the Postgres documentation <https://www.postgresql.org/docs/current/libpq-pgservice.html>`_�h]�hJ�+Section 33.16 of the Postgres documentation�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]��name��+Section 33.16 of the Postgres documentation��refuri��<https://www.postgresql.org/docs/current/libpq-pgservice.html�uhj�h j�ubh)��}�(h�? <https://www.postgresql.org/docs/current/libpq-pgservice.html>�h]�h}�(h]��+section-33-16-of-the-postgres-documentation�ah]�h]��+section 33.16 of the postgres documentation�ah]�h]��refuri�j135uhh136�137referenced�K
h j�ubhJ�
.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKTh j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKTh j>h!hubeh}�(h]�h]�h]�h]�h]�jxh�uhh�h"h#hK<h h&h!hubhV)��}�(h�'Click the *Parameters* tab to continue.�h]�(hJ�138Click the �����}�(h j/h!hh"NhNubh`)��}�(h�*Parameters*�h]�hJ�139Parameters�����}�(h j7h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j/ubhJ� tab to continue.�����}�(h j/h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKXh h&h!hubhz)��}�(h�[.. image:: images/server_parameters.png140    :alt: Server dialog ssl tab141    :align: center142�h]�h}�(h]�h]�h]�h]�h]��alt��Server dialog ssl tab��align��center��uri��images/server_parameters.png�h�}�h�j^suhhyh"h#hKZh h&h!hubhV)��}�(h�AUse the fields in the *Parameters* tab to configure a connection:�h]�(hJ�Use the fields in the �����}�(h j`h!hh"NhNubh`)��}�(h�*Parameters*�h]�hJ�143Parameters�����}�(h jhh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j`ubhJ� tab to configure a connection:�����}�(h j`h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK^h h&h!hubhV)��}�(h�KClick on the *+* button to add a new parameter. Some of the parameters are:�h]�(hJ�
Click on the �����}�(h j�h!hh"NhNubh`)��}�(h�*+*�h]�hJ�
+�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�; button to add a new parameter. Some of the parameters are:�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK`h h&h!hubh�)��}�(hhh]�(h�)��}�(hX'
*Host address* using this field to specify the host IP address may save time144by avoiding a DNS lookup on connection, but it may be useful to specify both145a host name and address when using Kerberos, GSSAPI, or SSPI authentication146methods, as well as for verify-full SSL certificate verification.�h]�hV)��}�(hX'
*Host address* using this field to specify the host IP address may save time147by avoiding a DNS lookup on connection, but it may be useful to specify both148a host name and address when using Kerberos, GSSAPI, or SSPI authentication149methods, as well as for verify-full SSL certificate verification.�h]�(h`)��}�(h�*Host address*�h]�hJ�Host address�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJX
 using this field to specify the host IP address may save time150by avoiding a DNS lookup on connection, but it may be useful to specify both151a host name and address when using Kerberos, GSSAPI, or SSPI authentication152methods, as well as for verify-full SSL certificate verification.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKbh j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKbh j�h!hubh�)��}�(hX(
*Password File* field to specify the location of a password file153(.pgpass). A .pgpass file allows a user to login without providing a password154when they connect.  For more information, see155`Section 33.15 of the Postgres documentation <https://www.postgresql.org/docs/current/libpq-pgpass.html>`_.�h]�hV)��}�(hX(
*Password File* field to specify the location of a password file156(.pgpass). A .pgpass file allows a user to login without providing a password157when they connect.  For more information, see158`Section 33.15 of the Postgres documentation <https://www.postgresql.org/docs/current/libpq-pgpass.html>`_.�h]�(h`)��}�(h�*Password File*�h]�hJ�
Password File�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�� field to specify the location of a password file159(.pgpass). A .pgpass file allows a user to login without providing a password160when they connect.  For more information, see161�����}�(h j�h!hh"NhNubj�)��}�(h�j`Section 33.15 of the Postgres documentation <https://www.postgresql.org/docs/current/libpq-pgpass.html>`_�h]�hJ�+Section 33.15 of the Postgres documentation�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]��name��+Section 33.15 of the Postgres documentation�j	�9https://www.postgresql.org/docs/current/libpq-pgpass.html�uhj�h j�ubh)��}�(h�< <https://www.postgresql.org/docs/current/libpq-pgpass.html>�h]�h}�(h]��+section-33-15-of-the-postgres-documentation�ah]�h]��+section 33.15 of the postgres documentation�ah]�h]��refuri�j�uhh162jK
h j�ubhJ�
.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKfh j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKfh j�h!hubh�)��}�(h��*Connection timeout* field to specify the maximum wait for connection,163in seconds. Zero or not specified means wait indefinitely. It is not164recommended to use a timeout of less than 2 seconds. By default it is set to16510 seconds.�h]�hV)��}�(h��*Connection timeout* field to specify the maximum wait for connection,166in seconds. Zero or not specified means wait indefinitely. It is not167recommended to use a timeout of less than 2 seconds. By default it is set to16810 seconds.�h]�(h`)��}�(h�*Connection timeout*�h]�hJ�Connection timeout�����}�(h jh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jubhJ�� field to specify the maximum wait for connection,169in seconds. Zero or not specified means wait indefinitely. It is not170recommended to use a timeout of less than 2 seconds. By default it is set to17110 seconds.�����}�(h jh!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKjh jubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKjh j�h!hubh�)��}�(h��*SSL mode* field to select the type of SSL connection the server should use.172For more information about using SSL encryption, see173`Section 33.18 of the Postgres documentation <https://www.postgresql.org/docs/current/libpq-ssl.html>`_.174�h]�hV)��}�(h��*SSL mode* field to select the type of SSL connection the server should use.175For more information about using SSL encryption, see176`Section 33.18 of the Postgres documentation <https://www.postgresql.org/docs/current/libpq-ssl.html>`_.�h]�(h`)��}�(h�177*SSL mode*�h]�hJ�SSL mode�����}�(h j?h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j;ubhJ�x field to select the type of SSL connection the server should use.178For more information about using SSL encryption, see179�����}�(h j;h!hh"NhNubj�)��}�(h�g`Section 33.18 of the Postgres documentation <https://www.postgresql.org/docs/current/libpq-ssl.html>`_�h]�hJ�+Section 33.18 of the Postgres documentation�����}�(h jQh!hh"NhNubah}�(h]�h]�h]�h]�h]��name��+Section 33.18 of the Postgres documentation�j	�6https://www.postgresql.org/docs/current/libpq-ssl.html�uhj�h j;ubh)��}�(h�9 <https://www.postgresql.org/docs/current/libpq-ssl.html>�h]�h}�(h]��+section-33-18-of-the-postgres-documentation�ah]�h]��+section 33.18 of the postgres documentation�ah]�h]��refuri�jauhh180jK
h j;ubhJ�
.�����}�(h j;h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKnh j7ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKnh j�h!hubeh}�(h]�h]�h]�h]�h]�jxh�uhh�h"h#hKbh h&h!hubhV)��}�(hX
If pgAdmin is installed in Server mode (the default mode), you can use the181platform-specific File manager dialog to upload files that support SSL182encryption to the server.  To access the File manager dialog, click the183icon that is located to the right of each of the following fields.�h]�hJX
If pgAdmin is installed in Server mode (the default mode), you can use the184platform-specific File manager dialog to upload files that support SSL185encryption to the server.  To access the File manager dialog, click the186icon that is located to the right of each of the following fields.�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhhUh"h#hKrh h&h!hubh�)��}�(hhh]�(h�)��}�(hX\
*Client certificate* field to specify the file containing the client187SSL certificate.  This file will replace the default188*~/.postgresql/postgresql.crt* if pgAdmin is installed in Desktop mode, and189*<STORAGE_DIR>/<USERNAME>/.postgresql/postgresql.crt* if pgAdmin is installed190in Web mode. This parameter is ignored if an SSL connection is not made.�h]�hV)��}�(hX\
*Client certificate* field to specify the file containing the client191SSL certificate.  This file will replace the default192*~/.postgresql/postgresql.crt* if pgAdmin is installed in Desktop mode, and193*<STORAGE_DIR>/<USERNAME>/.postgresql/postgresql.crt* if pgAdmin is installed194in Web mode. This parameter is ignored if an SSL connection is not made.�h]�(h`)��}�(h�*Client certificate*�h]�hJ�Client certificate�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�f field to specify the file containing the client195SSL certificate.  This file will replace the default196�����}�(h j�h!hh"NhNubh`)��}�(h�*~/.postgresql/postgresql.crt*�h]�hJ�~/.postgresql/postgresql.crt�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�. if pgAdmin is installed in Desktop mode, and197�����}�(h j�h!hh"NhNubh`)��}�(h�5*<STORAGE_DIR>/<USERNAME>/.postgresql/postgresql.crt*�h]�hJ�3<STORAGE_DIR>/<USERNAME>/.postgresql/postgresql.crt�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�a if pgAdmin is installed198in Web mode. This parameter is ignored if an SSL connection is not made.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hKwh j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hKwh j�h!hubh�)��}�(hXt
*Client certificate key* field to specify the file containing the199secret key used for the client certificate.  This file will replace the200default *~/.postgresql/postgresql.key* if pgAdmin is installed in Desktop201mode, and *<STORAGE_DIR>/<USERNAME>/.postgresql/postgresql.key* if pgAdmin202is installed in Web mode. This parameter is ignored if an SSL connection is203not made.�h]�hV)��}�(hXt
*Client certificate key* field to specify the file containing the204secret key used for the client certificate.  This file will replace the205default *~/.postgresql/postgresql.key* if pgAdmin is installed in Desktop206mode, and *<STORAGE_DIR>/<USERNAME>/.postgresql/postgresql.key* if pgAdmin207is installed in Web mode. This parameter is ignored if an SSL connection is208not made.�h]�(h`)��}�(h�*Client certificate key*�h]�hJ�Client certificate key�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�z field to specify the file containing the209secret key used for the client certificate.  This file will replace the210default �����}�(h j�h!hh"NhNubh`)��}�(h�*~/.postgresql/postgresql.key*�h]�hJ�~/.postgresql/postgresql.key�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�. if pgAdmin is installed in Desktop211mode, and �����}�(h j�h!hh"NhNubh`)��}�(h�5*<STORAGE_DIR>/<USERNAME>/.postgresql/postgresql.key*�h]�hJ�3<STORAGE_DIR>/<USERNAME>/.postgresql/postgresql.key�����}�(h jh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�a if pgAdmin212is installed in Web mode. This parameter is ignored if an SSL connection is213not made.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK|h j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK|h j�h!hubh�)��}�(h��*Root certificate* field to specify the file containing the SSL214certificate authority.  This file will replace the default215*~/.postgresql/root.crt*. This parameter is ignored if an SSL connection is216not made.�h]�hV)��}�(h��*Root certificate* field to specify the file containing the SSL217certificate authority.  This file will replace the default218*~/.postgresql/root.crt*. This parameter is ignored if an SSL connection is219not made.�h]�(h`)��}�(h�*Root certificate*�h]�hJ�Root certificate�����}�(h j2h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j.ubhJ�i field to specify the file containing the SSL220certificate authority.  This file will replace the default221�����}�(h j.h!hh"NhNubh`)��}�(h�*~/.postgresql/root.crt*�h]�hJ�~/.postgresql/root.crt�����}�(h jDh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j.ubhJ�=. This parameter is ignored if an SSL connection is222not made.�����}�(h j.h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j*ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h j�h!hubh�)��}�(h��*Certificate revocation list* field to specify the file containing223the SSL certificate revocation list.  This list will replace the default list,224found in *~/.postgresql/root.crl*. This parameter is ignored if an SSL225connection is not made.�h]�hV)��}�(h��*Certificate revocation list* field to specify the file containing226the SSL certificate revocation list.  This list will replace the default list,227found in *~/.postgresql/root.crl*. This parameter is ignored if an SSL228connection is not made.�h]�(h`)��}�(h�*Certificate revocation list*�h]�hJ�Certificate revocation list�����}�(h jjh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jfubhJ�~ field to specify the file containing229the SSL certificate revocation list.  This list will replace the default list,230found in �����}�(h jfh!hh"NhNubh`)��}�(h�*~/.postgresql/root.crl*�h]�hJ�~/.postgresql/root.crl�����}�(h j|h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jfubhJ�=. This parameter is ignored if an SSL231connection is not made.�����}�(h jfh!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h jbubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h j�h!hubh�)��}�(h��*SSL compression?* is set to *True*, data sent over SSL connections will232be compressed.  The default value is *False* (compression is disabled). This233parameter is ignored if an SSL connection is not made.234�h]�hV)��}�(h��*SSL compression?* is set to *True*, data sent over SSL connections will235be compressed.  The default value is *False* (compression is disabled). This236parameter is ignored if an SSL connection is not made.�h]�(h`)��}�(h�*SSL compression?*�h]�hJ�SSL compression?�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ� is set to �����}�(h j�h!hh"NhNubh`)��}�(h�*True*�h]�hJ�True�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�K, data sent over SSL connections will237be compressed.  The default value is �����}�(h j�h!hh"NhNubh`)��}�(h�*False*�h]�hJ�False�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ�W (compression is disabled). This238parameter is ignored if an SSL connection is not made.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h j�h!hubeh}�(h]�h]�h]�h]�h]�jxh�uhh�h"h#hKwh h&h!hubh	�warning���)��}�(hXj
In Server mode, certificates, private keys, and the revocation list239are stored in the per-user file storage area on the server, which is owned240by the user account under which the pgAdmin server process is run. This241means that administrators of the server may be able to access those files;242appropriate caution should be taken before choosing to use this feature.�h]�hV)��}�(hXj
In Server mode, certificates, private keys, and the revocation list243are stored in the per-user file storage area on the server, which is owned244by the user account under which the pgAdmin server process is run. This245means that administrators of the server may be able to access those files;246appropriate caution should be taken before choosing to use this feature.�h]�hJXj
In Server mode, certificates, private keys, and the revocation list247are stored in the per-user file storage area on the server, which is owned248by the user account under which the pgAdmin server process is run. This249means that administrators of the server may be able to access those files;250appropriate caution should be taken before choosing to use this feature.�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j�ubah}�(h]�h]�h]�h]�h]�uhj�h"h#hK�h h&h!hubhV)��}�(h�'Click the *SSH Tunnel* tab to continue.�h]�(hJ�251Click the �����}�(h jh!hh"NhNubh`)��}�(h�*SSH Tunnel*�h]�hJ�252SSH Tunnel�����}�(h jh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jubhJ� tab to continue.�����}�(h jh!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h h&h!hubhz)��}�(h�b.. image:: images/server_ssh_tunnel.png253    :alt: Server dialog ssh tunnel tab254    :align: center255�h]�h}�(h]�h]�h]�h]�h]��alt��Server dialog ssh tunnel tab��align��center��uri��images/server_ssh_tunnel.png�h�}�h�j3suhhyh"h#hK�h h&h!hubhV)��}�(h�BUse the fields in the *SSH Tunnel* tab to configure SSH Tunneling:�h]�(hJ�Use the fields in the �����}�(h j5h!hh"NhNubh`)��}�(h�*SSH Tunnel*�h]�hJ�256SSH Tunnel�����}�(h j=h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j5ubhJ�  tab to configure SSH Tunneling:�����}�(h j5h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h h&h!hubhV)��}�(h��You can use the "SSH Tunnel" tab to connect pgAdmin (through an intermediary257proxy host) to a server that resides on a network to which the client may258not be able to connect directly.�h]�hJ��You can use the “SSH Tunnel” tab to connect pgAdmin (through an intermediary259proxy host) to a server that resides on a network to which the client may260not be able to connect directly.�����}�(h jUh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h h&h!hubh�)��}�(hhh]�(h�)��}�(h�zSet "Use SSH tunneling" to *Yes* to specify that pgAdmin should use an SSH261tunnel when connecting to the specified server.�h]�hV)��}�(h�zSet "Use SSH tunneling" to *Yes* to specify that pgAdmin should use an SSH262tunnel when connecting to the specified server.�h]�(hJ�Set “Use SSH tunneling” to �����}�(h jjh!hh"NhNubh`)��}�(h�*Yes*�h]�hJ�Yes�����}�(h jrh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jjubhJ�Z to specify that pgAdmin should use an SSH263tunnel when connecting to the specified server.�����}�(h jjh!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h jfubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h jch!hubh�)��}�(h�Specify the name or IP address of the SSH host (through which client264connections will be forwarded) in the *Tunnel host* field.�h]�hV)��}�(h�Specify the name or IP address of the SSH host (through which client265connections will be forwarded) in the *Tunnel host* field.�h]�(hJ�kSpecify the name or IP address of the SSH host (through which client266connections will be forwarded) in the �����}�(h j�h!hh"NhNubh`)��}�(h�
*Tunnel host*�h]�hJ�Tunnel host�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ� field.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h jch!hubh�)��}�(h�qSpecify the port of the SSH host (through which client connections will be267forwarded) in the *Tunnel port* field.�h]�hV)��}�(h�qSpecify the port of the SSH host (through which client connections will be268forwarded) in the *Tunnel port* field.�h]�(hJ�]Specify the port of the SSH host (through which client connections will be269forwarded) in the �����}�(h j�h!hh"NhNubh`)��}�(h�
*Tunnel port*�h]�hJ�Tunnel port�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ� field.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h jch!hubh�)��}�(h�ZSpecify the name of a user with login privileges for the SSH host in the270*Username* field.�h]�hV)��}�(h�ZSpecify the name of a user with login privileges for the SSH host in the271*Username* field.�h]�(hJ�ISpecify the name of a user with login privileges for the SSH host in the272�����}�(h j�h!hh"NhNubh`)��}�(h�273*Username*�h]�hJ�Username�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJ� field.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h jch!hubh�)��}�(hXg
Specify the type of authentication that will be used when connecting to the274SSH host in the *Authentication* field:275 276  * Select the *Password* option to specify that pgAdmin will use a password277    for authentication to the SSH host. This is the default.278  * Select the *Identity file* to specify that pgAdmin will use a private key279    file when connecting.280�h]�(hV)��}�(h�sSpecify the type of authentication that will be used when connecting to the281SSH host in the *Authentication* field:�h]�(hJ�\Specify the type of authentication that will be used when connecting to the282SSH host in the �����}�(h j	h!hh"NhNubh`)��}�(h�*Authentication*�h]�hJ�Authentication�����}�(h j	h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j	ubhJ� field:�����}�(h j	h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j	ubj
)��}�(h��* Select the *Password* option to specify that pgAdmin will use a password283  for authentication to the SSH host. This is the default.284* Select the *Identity file* to specify that pgAdmin will use a private key285  file when connecting.286�h]�h�)��}�(hhh]�(h�)��}�(h��Select the *Password* option to specify that pgAdmin will use a password287for authentication to the SSH host. This is the default.�h]�hV)��}�(h��Select the *Password* option to specify that pgAdmin will use a password288for authentication to the SSH host. This is the default.�h]�(hJ�Select the �����}�(h j=	h!hh"NhNubh`)��}�(h�289*Password*�h]�hJ�Password�����}�(h jE	h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j=	ubhJ�l option to specify that pgAdmin will use a password290for authentication to the SSH host. This is the default.�����}�(h j=	h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j9	ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h j6	ubh�)��}�(h�`Select the *Identity file* to specify that pgAdmin will use a private key291file when connecting.292�h]�hV)��}�(h�_Select the *Identity file* to specify that pgAdmin will use a private key293file when connecting.�h]�(hJ�Select the �����}�(h jg	h!hh"NhNubh`)��}�(h�*Identity file*�h]�hJ�
Identity file�����}�(h jo	h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jg	ubhJ�E to specify that pgAdmin will use a private key294file when connecting.�����}�(h jg	h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h jc	ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h j6	ubeh}�(h]�h]�h]�h]�h]�jxh�uhh�h"h#hK�h j2	ubah}�(h]�h]�h]�h]�h]�uhjh"h#hK�h j	ubeh}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h jch!hubh�)��}�(h��If the SSH host is expecting a private key file for authentication, use the295*Identity file* field to specify the location of the key file.�h]�hV)��}�(h��If the SSH host is expecting a private key file for authentication, use the296*Identity file* field to specify the location of the key file.�h]�(hJ�LIf the SSH host is expecting a private key file for authentication, use the297�����}�(h j�	h!hh"NhNubh`)��}�(h�*Identity file*�h]�hJ�
Identity file�����}�(h j�	h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�	ubhJ�/ field to specify the location of the key file.�����}�(h j�	h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j�	ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h jch!hubh�)��}�(h��If the SSH host is expecting a password of the user name or an identity file298if being used, use the *Password* field to specify the password.�h]�hV)��}�(h��If the SSH host is expecting a password of the user name or an identity file299if being used, use the *Password* field to specify the password.�h]�(hJ�dIf the SSH host is expecting a password of the user name or an identity file300if being used, use the �����}�(h j�	h!hh"NhNubh`)��}�(h�301*Password*�h]�hJ�Password�����}�(h j�	h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�	ubhJ� field to specify the password.�����}�(h j�	h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j�	ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h jch!hubh�)��}�(h��Check the box next to *Save password?* to instruct pgAdmin to save the302password for future use. Use303:ref:`Clear SSH Tunnel Password <clear_saved_passwords>` to remove the saved304password.�h]�hV)��}�(h��Check the box next to *Save password?* to instruct pgAdmin to save the305password for future use. Use306:ref:`Clear SSH Tunnel Password <clear_saved_passwords>` to remove the saved307password.�h]�(hJ�Check the box next to �����}�(h j�	h!hh"NhNubh`)��}�(h�*Save password?*�h]�hJ�Save password?�����}�(h j�	h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�	ubhJ�> to instruct pgAdmin to save the308password for future use. Use309�����}�(h j�	h!hh"NhNubj�
)��}�(h�8:ref:`Clear SSH Tunnel Password <clear_saved_passwords>`�h]�j�
)��}�(hj310h]�hJ�Clear SSH Tunnel Password�����}�(h j311h!hh"NhNubah}�(h]�h]�(j�
�std��std-ref�eh]�h]�h]�uhj�
h j312ubah}�(h]�h]�h]�h]�h]��refdoc�j�
�	refdomain�j313�reftype��ref��refexplicit���refwarn��j�clear_saved_passwords�uhj�
h"h#hK�h j�	ubhJ� to remove the saved314password.�����}�(h j�	h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j�	ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h jch!hubh�)��}�(hX+
Use the *Keep alive* field to specify interval in seconds defining the period315in which, if no data was sent over the connection, a ‘keepalive’ packet will316be sent (and ignored by the remote host). This can be useful to keep317connections alive over a NAT. You can set to 0 for disable keepalive.318 319�h]�hV)��}�(hX)
Use the *Keep alive* field to specify interval in seconds defining the period320in which, if no data was sent over the connection, a ‘keepalive’ packet will321be sent (and ignored by the remote host). This can be useful to keep322connections alive over a NAT. You can set to 0 for disable keepalive.�h]�(hJ�Use the �����}�(h jE323h!hh"NhNubh`)��}�(h�*Keep alive*�h]�hJ�324Keep alive�����}�(h jM325h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jE326ubhJX
 field to specify interval in seconds defining the period327in which, if no data was sent over the connection, a ‘keepalive’ packet will328be sent (and ignored by the remote host). This can be useful to keep329connections alive over a NAT. You can set to 0 for disable keepalive.�����}�(h jE330h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h jA331ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h jch!hubeh}�(h]�h]�h]�h]�h]�jxh�uhh�h"h#hK�h h&h!hubhV)��}�(h�%Click the *Advanced* tab to continue.�h]�(hJ�332Click the �����}�(h jq333h!hh"NhNubh`)��}�(h�334*Advanced*�h]�hJ�Advanced�����}�(h jy335h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jq336ubhJ� tab to continue.�����}�(h jq337h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h h&h!hubhz)��}�(h�^.. image:: images/server_advanced.png338    :alt: Server dialog advanced tab339    :align: center340�h]�h}�(h]�h]�h]�h]�h]��alt��Server dialog advanced tab��align��center��uri��images/server_advanced.png�h�}�h�j�341suhhyh"h#hK�h h&h!hubhV)��}�(h�?Use the fields in the *Advanced* tab to configure a connection:�h]�(hJ�Use the fields in the �����}�(h j�342h!hh"NhNubh`)��}�(h�343*Advanced*�h]�hJ�Advanced�����}�(h j�344h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�345ubhJ� tab to configure a connection:�����}�(h j�346h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h h&h!hubh�)��}�(hhh]�(h�)��}�(hX5
Use the *DB restriction* field to provide a SQL restriction that will be used347against the pg_database table to limit the databases that you see. For348example, you might enter: *live_db test_db* so that only live_db and test_db349are shown in the pgAdmin browser. Separate entries with a comma or tab as you350type.�h]�hV)��}�(hX5
Use the *DB restriction* field to provide a SQL restriction that will be used351against the pg_database table to limit the databases that you see. For352example, you might enter: *live_db test_db* so that only live_db and test_db353are shown in the pgAdmin browser. Separate entries with a comma or tab as you354type.�h]�(hJ�Use the �����}�(h j�355h!hh"NhNubh`)��}�(h�*DB restriction*�h]�hJ�DB restriction�����}�(h j�356h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�357ubhJ�� field to provide a SQL restriction that will be used358against the pg_database table to limit the databases that you see. For359example, you might enter: �����}�(h j�360h!hh"NhNubh`)��}�(h�*live_db test_db*�h]�hJ�live_db test_db�����}�(h j�361h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�362ubhJ�u so that only live_db and test_db363are shown in the pgAdmin browser. Separate entries with a comma or tab as you364type.�����}�(h j�365h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j�366ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h j�367h!hubh�)��}�(hX�
Use the *Password exec command* field to specify a shell command to be executed368to retrieve a password to be used for SQL authentication. The ``stdout`` of the369command will be used as the SQL password. This may be useful when the password370should be generated as a transient authorization token instead of providing a371password when connecting in `PAM authentication <https://www.postgresql.org/docs/current/auth-pam.html>`_ scenarios.�h]�hV)��}�(hX�
Use the *Password exec command* field to specify a shell command to be executed372to retrieve a password to be used for SQL authentication. The ``stdout`` of the373command will be used as the SQL password. This may be useful when the password374should be generated as a transient authorization token instead of providing a375password when connecting in `PAM authentication <https://www.postgresql.org/docs/current/auth-pam.html>`_ scenarios.�h]�(hJ�Use the �����}�(h jh!hh"NhNubh`)��}�(h�*Password exec command*�h]�hJ�Password exec command�����}�(h j
h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jubhJ�o field to specify a shell command to be executed376to retrieve a password to be used for SQL authentication. The �����}�(h jh!hh"NhNubh	�literal���)��}�(h�377``stdout``�h]�hJ�stdout�����}�(h j!h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhjh jubhJ�� of the378command will be used as the SQL password. This may be useful when the password379should be generated as a transient authorization token instead of providing a380password when connecting in �����}�(h jh!hh"NhNubj�)��}�(h�M`PAM authentication <https://www.postgresql.org/docs/current/auth-pam.html>`_�h]�hJ�PAM authentication�����}�(h j3h!hh"NhNubah}�(h]�h]�h]�h]�h]��name��PAM authentication�j	�5https://www.postgresql.org/docs/current/auth-pam.html�uhj�h jubh)��}�(h�8 <https://www.postgresql.org/docs/current/auth-pam.html>�h]�h}�(h]��pam-authentication�ah]�h]��pam authentication�ah]�h]��refuri�jCuhh381jK
h jubhJ� scenarios.�����}�(h jh!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j
ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h j�382h!hubh�)��}�(hX�
Use the *Password exec expiration* field to specify a maximum age, in seconds,383of the password generated with a *Password exec command*. If not specified,384the password will not expire until your pgAdmin session does.385Zero means the command will be executed for each new connection or reconnection that is made.386If the generated password is not valid indefinitely, set this value to slightly before it will expire.�h]�hV)��}�(hX�
Use the *Password exec expiration* field to specify a maximum age, in seconds,387of the password generated with a *Password exec command*. If not specified,388the password will not expire until your pgAdmin session does.389Zero means the command will be executed for each new connection or reconnection that is made.390If the generated password is not valid indefinitely, set this value to slightly before it will expire.�h]�(hJ�Use the �����}�(h jeh!hh"NhNubh`)��}�(h�*Password exec expiration*�h]�hJ�Password exec expiration�����}�(h jmh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jeubhJ�N field to specify a maximum age, in seconds,391of the password generated with a �����}�(h jeh!hh"NhNubh`)��}�(h�*Password exec command*�h]�hJ�Password exec command�����}�(h jh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jeubhJX
. If not specified,392the password will not expire until your pgAdmin session does.393Zero means the command will be executed for each new connection or reconnection that is made.394If the generated password is not valid indefinitely, set this value to slightly before it will expire.�����}�(h jeh!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h jaubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h j�395h!hubh�)��}�(hX�
Use the *Prepare threshold* field to specify the number of times a query is396executed before it is prepared. If it is set to 0, every query is prepared397the first time it is executed. If it is set to blank, prepared statements are disabled398on the connection. This is particularly useful with external connection poolers,399such as PgBouncer, which is not compatible with prepared statements. Set this to400blank in such cases.401�h]�hV)��}�(hX�
Use the *Prepare threshold* field to specify the number of times a query is402executed before it is prepared. If it is set to 0, every query is prepared403the first time it is executed. If it is set to blank, prepared statements are disabled404on the connection. This is particularly useful with external connection poolers,405such as PgBouncer, which is not compatible with prepared statements. Set this to406blank in such cases.�h]�(hJ�Use the �����}�(h j�h!hh"NhNubh`)��}�(h�*Prepare threshold*�h]�hJ�Prepare threshold�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j�ubhJX�
 field to specify the number of times a query is407executed before it is prepared. If it is set to 0, every query is prepared408the first time it is executed. If it is set to blank, prepared statements are disabled409on the connection. This is particularly useful with external connection poolers,410such as PgBouncer, which is not compatible with prepared statements. Set this to411blank in such cases.�����}�(h j�h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j�ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h j�412h!hubeh}�(h]�h]�h]�h]�h]�jxh�uhh�h"h#hK�h h&h!hubh	�note���)��}�(h�oThe password file option is only supported when pgAdmin is using libpq413v10.0 or later to connect to the server.�h]�hV)��}�(h�oThe password file option is only supported when pgAdmin is using libpq414v10.0 or later to connect to the server.�h]�hJ�oThe password file option is only supported when pgAdmin is using libpq415v10.0 or later to connect to the server.�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j�ubah}�(h]�h]�h]�h]�h]�uhj�h"h#hK�h h&h!hubj�)��}�(h�OThe Password exec option is only supported when pgAdmin is run in desktop mode.�h]�hV)��}�(hj�h]�hJ�OThe Password exec option is only supported when pgAdmin is run in desktop mode.�����}�(h j�h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j�ubah}�(h]�h]�h]�h]�h]�uhj�h"h#hK�h h&h!hubh�)��}�(hhh]�(h�)��}�(h�*Click the *Save* button to save your work.�h]�hV)��}�(hjh]�(hJ�416Click the �����}�(h jh!hh"NhNubh`)��}�(h�*Save*�h]�hJ�Save�����}�(h jh!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jubhJ� button to save your work.�����}�(h jh!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j
ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h j�h!hubh�)��}�(h�:Click the *Close* button to exit without saving your work.�h]�hV)��}�(hj,h]�(hJ�417Click the �����}�(h j.h!hh"NhNubh`)��}�(h�*Close*�h]�hJ�Close�����}�(h j5h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h j.ubhJ�) button to exit without saving your work.�����}�(h j.h!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h j*ubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h j�h!hubh�)��}�(h�jClick the *Reset* button to return the values specified on the Server dialog418to their original condition.419�h]�hV)��}�(h�iClick the *Reset* button to return the values specified on the Server dialog420to their original condition.�h]�(hJ�421Click the �����}�(h jWh!hh"NhNubh`)��}�(h�*Reset*�h]�hJ�Reset�����}�(h j_h!hh"NhNubah}�(h]�h]�h]�h]�h]�uhh_h jWubhJ�X button to return the values specified on the Server dialog422to their original condition.�����}�(h jWh!hh"NhNubeh}�(h]�h]�h]�h]�h]�uhhUh"h#hK�h jSubah}�(h]�h]�h]�h]�h]�uhh�h"h#hK�h j�h!hubeh}�(h]�h]�h]�h]�h]�jxh�uhh�h"h#hK�h h&h!hubh	�compound���)��}�(hhh]�h�toctree���)��}�(hhh]�h}�(h]�h]�h]�h]�h]�h j�
�entries�]�N�clear_saved_passwords���a�includefiles�]�j�a�maxdepth�J�����caption�N�glob���hidden���
includehidden���numbered�K�423titlesonly���424rawentries�]�uhj�h"h#hK�h j�ubah}�(h]�h]��toctree-wrapper�ah]�h]�h]�uhj�h h&h!hh"h#hK�ubeh}�(h]�(h�id1�eh]�h]�(�
server dialog��
server_dialog�eh]�h]�uhh$h hh!hh"h#hK�expect_referenced_by_name�}�j�hs�expect_referenced_by_id�}�hhsubeh}�(h]�h]�h]�h]�h]��source�h#�translation_progress�}�(�total�K�425translated�Kuuhh
�current_source�N�current_line�N�settings��docutils.frontend��Values���)��}�(�output�Nh)N�	generator�N�	datestamp�N�root_prefix��
/��source_link�N�426source_url�N�
toc_backlinks��entry��footnote_backlinks���
sectnum_xform���strip_comments�N�strip_elements_with_classes�N�
strip_classes�N�report_level�K�427halt_level�K�exit_status_level�K�debug�N�warning_stream�N�	traceback���input_encoding��	utf-8-sig��input_encoding_error_handler��strict��output_encoding��utf-8��output_encoding_error_handler�j��error_encoding��cp1252��error_encoding_error_handler��backslashreplace��
language_code��en��record_dependencies�N�config�N�	id_prefix�h�auto_id_prefix��id��
dump_settings�N�dump_internals�N�dump_transforms�N�dump_pseudo_xml�N�expose_internals�N�strict_visitor�N�_disable_config�N�_source�h#�_destination�N�
_config_files�]��file_insertion_enabled���raw_enabled�K
�line_length_limit�M'�pep_references�N�pep_base_url��https://peps.python.org/��pep_file_url_template��pep-%04d��rfc_references�N�rfc_base_url��&https://datatracker.ietf.org/doc/html/��	tab_width�K�trim_footnote_reference_space���syntax_highlight��long��smart_quotes���smartquotes_locales�]��character_level_inline_markup���doctitle_xform���
docinfo_xform���sectsubtitle_xform���
image_loading��link��embed_stylesheet���cloak_email_addresses���section_self_link���env�Nub�reporter�N�indirect_targets�]��substitution_defs�}��substitution_names�}��refnames�}��refids�}�h]�has�nameids�}�(j�hj�j�jjj�j�jkjhjMjJu�	nametypes�}�(j��j��j�j��jk�jM�uh}�(hh&j�h&jjj�j�jhjbjJjDu�
footnote_refs�}��
citation_refs�}��
autofootnotes�]��autofootnote_refs�]��symbol_footnotes�]��symbol_footnote_refs�]��	footnotes�]��	citations�]��autofootnote_start�K
�symbol_footnote_start�K�428id_counter��collections��Counter���}�j�K
s��R��parse_messages�]��transform_messages�]�(h	�system_message���)��}�(hhh]�hV)��}�(hhh]�hJ�3Hyperlink target "server-dialog" is not referenced.�����}�h jI
sbah}�(h]�h]�h]�h]�h]�uhhUh jF
ubah}�(h]�h]�h]�h]�h]��level�K
�type��INFO��source�h#�line�K
uhjD
ubjE
)��}�(hhh]�hV)��}�(hhh]�hJ�-Hyperlink target "index-0" is not referenced.�����}�h jd
sbah}�(h]�h]�h]�h]�h]�uhhUh ja
ubah}�(h]�h]�h]�h]�h]��level�K
�type�j^
�source�h#�line�KuhjD
ube�transformer�N�include_log�]��429decoration�Nh!hub.