Datasetpublic
codekingpro/portable-devtools

sourceHugging Faceupdated 5mo agoView on Hugging Face
1likes14kdownloads
mfa.html216 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>Enabling two-factor authentication (2FA) &#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="User Management Dialog" href="user_management.html" />
23    <link rel="prev" title="Login Page" href="login.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="user_management.html" title="User Management Dialog"
33             accesskey="N">next</a> |</li>
34        <li class="right" >
35          <a href="login.html" title="Login Page"
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="getting_started.html" accesskey="U">Getting Started</a> &#187;</li>
39        <li class="nav-item nav-item-this"><a href="">Enabling two-factor authentication (2FA)</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="enabling-two-factor-authentication-2fa">
49<span id="mfa"></span><h1><span class="target" id="index-0"></span>Enabling two-factor authentication (2FA)<a class="headerlink" href="#enabling-two-factor-authentication-2fa" title="Link to this heading">¶</a></h1>
50<section id="about-two-factor-authentication">
51<h2>About two-factor authentication<a class="headerlink" href="#about-two-factor-authentication" title="Link to this heading">¶</a></h2>
52<p>Two-factor authentication (2FA) is an extra layer of security used when logging
53into websites or apps. With 2FA, you have to log in with your username and
54password and provide another form of authentication that only you know or have
55access to.</p>
56</section>
57<section id="setup-two-factor-authentication">
58<h2>Setup two-factor authentication<a class="headerlink" href="#setup-two-factor-authentication" title="Link to this heading">¶</a></h2>
59<p>To set up 2FA for pgAdmin 4, you must configure the Two-factor Authentication
60settings in <em>config_local.py</em> or <em>config_system.py</em> (see the
61<a class="reference internal" href="config_py.html#config-py"><span class="std std-ref">config.py</span></a> documentation) on the system where pgAdmin is
62installed in Server mode. You can copy these settings from <em>config.py</em> file and
63modify the values for the following parameters.</p>
64<table class="longtable docutils align-default">
65<colgroup>
66<col style="width: 38.9%" />
67<col style="width: 61.1%" />
68</colgroup>
69<thead>
70<tr class="row-odd"><th class="head"><p><strong>Parameter</strong></p></th>
71<th class="head"><p><strong>Description</strong></p></th>
72</tr>
73</thead>
74<tbody>
75<tr class="row-even"><td><p>MFA_ENABLED</p></td>
76<td><p>The default value for this parameter is True.
77To disable 2FA, set the value to <em>False</em></p></td>
78</tr>
79<tr class="row-odd"><td><p>SUPPORTED_MFA_LIST</p></td>
80<td><p>Set the authentication methods to be supported</p></td>
81</tr>
82<tr class="row-even"><td><p>MFA_EMAIL_SUBJECT</p></td>
83<td><p>&lt;APP_NAME&gt; - Verification Code e.g. pgAdmin 4 -
84Verification Code</p></td>
85</tr>
86<tr class="row-odd"><td><p>MFA_FORCE_REGISTRATION</p></td>
87<td><p>Force the user to configure the authentication
88method on login (if no authentication is already configured).</p></td>
89</tr>
90</tbody>
91</table>
92<p><em>NOTE: You must set the ‘Mail server settings’ in config_local.py or
93config_system.py in order to use ‘email’ as two-factor authentication method
94(see the</em> <a class="reference internal" href="config_py.html#config-py"><span class="std std-ref">config.py</span></a> <em>documentation).</em></p>
95</section>
96<section id="configure-two-factor-authentication">
97<h2>Configure two-factor authentication<a class="headerlink" href="#configure-two-factor-authentication" title="Link to this heading">¶</a></h2>
98<p>To configure 2FA for a user, you must click on ‘Two-factor Authentication’
99in the <cite>User</cite> menu in right-top corner. It will list down all the supported
100multi factor authentication methods. Click on ‘Setup’ of one of those methods
101and follow the steps for each authentication method. You will see the <cite>Delete</cite>
102button for the authentication method, which is already been configured.
103Clicking on <cite>Delete</cite> button will deregister the authentication method for the
104current user.</p>
105<img alt="Configure two-factor authentication" class="align-center" src="_images/mfa_registration.png" />
106<p>You can also force users to configure the two-factor
107authentication methods on login by setting <em>MFA_FORCE_REGISTRATION</em> parameter
108to <em>True</em>.</p>
109</section>
110</section>
111
112
113            <div class="clearer"></div>
114          </div>
115        </div>
116      </div>
117      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
118        <div class="sphinxsidebarwrapper">
119  <div>
120    <h3><a href="index.html">Table of Contents</a></h3>
121    <ul>
122<li><a class="reference internal" href="#">Enabling two-factor authentication (2FA)</a><ul>
123<li><a class="reference internal" href="#about-two-factor-authentication">About two-factor authentication</a></li>
124<li><a class="reference internal" href="#setup-two-factor-authentication">Setup two-factor authentication</a></li>
125<li><a class="reference internal" href="#configure-two-factor-authentication">Configure two-factor authentication</a></li>
126</ul>
127</li>
128</ul>
129
130  </div>
131<h3><a href="index.html">Table of Contents</a></h3>
132<ul class="current">
133<li class="toctree-l1 current"><a class="reference internal" href="getting_started.html">Getting Started</a><ul class="current">
134<li class="toctree-l2"><a class="reference internal" href="deployment.html">Deployment</a></li>
135<li class="toctree-l2"><a class="reference internal" href="login.html">Login Page</a></li>
136<li class="toctree-l2 current"><a class="current reference internal" href="#">Enabling two-factor authentication (2FA)</a></li>
137<li class="toctree-l2"><a class="reference internal" href="user_management.html">User Management Dialog</a></li>
138<li class="toctree-l2"><a class="reference internal" href="change_ownership.html">Change Ownership Dialog</a></li>
139<li class="toctree-l2"><a class="reference internal" href="change_user_password.html">Change User Password Dialog</a></li>
140<li class="toctree-l2"><a class="reference internal" href="restore_locked_user.html">Lock/Restore Account</a></li>
141<li class="toctree-l2"><a class="reference internal" href="ldap.html">Enabling LDAP Authentication</a></li>
142<li class="toctree-l2"><a class="reference internal" href="kerberos.html">Enabling Kerberos Authentication</a></li>
143<li class="toctree-l2"><a class="reference internal" href="oauth2.html">Enabling OAUTH2 Authentication</a></li>
144<li class="toctree-l2"><a class="reference internal" href="webserver.html">Enabling Webserver Authentication</a></li>
145<li class="toctree-l2"><a class="reference internal" href="user_interface.html">User Interface</a></li>
146<li class="toctree-l2"><a class="reference internal" href="menu_bar.html">Menu Bar</a></li>
147<li class="toctree-l2"><a class="reference internal" href="toolbar.html">Toolbar</a></li>
148<li class="toctree-l2"><a class="reference internal" href="tabbed_browser.html">Tabbed Browser</a></li>
149<li class="toctree-l2"><a class="reference internal" href="tree_control.html">Tree Control</a></li>
150<li class="toctree-l2"><a class="reference internal" href="preferences.html">Preferences Dialog</a></li>
151<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts:</a></li>
152<li class="toctree-l2"><a class="reference internal" href="search_objects.html">Search objects</a></li>
153</ul>
154</li>
155<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
156<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
157<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
158<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
159<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
160<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
161<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
162<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
163<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
164<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
165<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
166<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
167<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
168</ul>
169
170<search id="searchbox" style="display: none" role="search">
171  <h3 id="searchlabel">Quick search</h3>
172    <div class="searchformwrapper">
173    <form class="search" action="search.html" method="get">
174      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
175      <input type="submit" value="Go" />
176    </form>
177    </div>
178</search>
179<script>document.getElementById('searchbox').style.display = "block"</script>
180        </div>
181<div id="sidebarbutton" title="Collapse sidebar">
182<span>«</span>
183</div>
184
185      </div>
186      <div class="clearer"></div>
187    </div>
188    <div class="related" role="navigation" aria-label="related navigation">
189      <h3>Navigation</h3>
190      <ul>
191        <li class="right" style="margin-right: 10px">
192          <a href="genindex.html" title="General Index"
193             >index</a></li>
194        <li class="right" >
195          <a href="user_management.html" title="User Management Dialog"
196             >next</a> |</li>
197        <li class="right" >
198          <a href="login.html" title="Login Page"
199             >previous</a> |</li>
200        <li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> &#187;</li>
201          <li class="nav-item nav-item-1"><a href="getting_started.html" >Getting Started</a> &#187;</li>
202        <li class="nav-item nav-item-this"><a href="">Enabling two-factor authentication (2FA)</a></li> 
203      </ul>
204    </div>
205    <div class="footer" role="contentinfo">
206        <div class="related" role="navigation" aria-label="related navigation">
207          <ul>
208              <li class="left" style="margin-left: 10px">&#169; Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
209            <li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
210            <li class="right" ><a href="user_management.html" title="User Management Dialog" accesskey="N">next</a> |</li>
211            <li class="right" ><a href="login.html" title="Login Page" accesskey="P">previous</a> |</li>
212          </ul>
213        </div>
214    </div>
215  </body>
216</html>