<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Index — Certbot 0.14.2 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="#"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="Certbot 0.14.2 documentation" href="index.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> Certbot
</a>
<div class="version">
0.14
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Get Certbot</a></li>
<li class="toctree-l1"><a class="reference internal" href="using.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Developer Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="packaging.html">Packaging Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="resources.html">Resources</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Certbot</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li></li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#_"><strong>_</strong></a>
| <a href="#A"><strong>A</strong></a>
| <a href="#B"><strong>B</strong></a>
| <a href="#C"><strong>C</strong></a>
| <a href="#D"><strong>D</strong></a>
| <a href="#E"><strong>E</strong></a>
| <a href="#F"><strong>F</strong></a>
| <a href="#G"><strong>G</strong></a>
| <a href="#H"><strong>H</strong></a>
| <a href="#I"><strong>I</strong></a>
| <a href="#K"><strong>K</strong></a>
| <a href="#L"><strong>L</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#N"><strong>N</strong></a>
| <a href="#O"><strong>O</strong></a>
| <a href="#P"><strong>P</strong></a>
| <a href="#R"><strong>R</strong></a>
| <a href="#S"><strong>S</strong></a>
| <a href="#T"><strong>T</strong></a>
| <a href="#V"><strong>V</strong></a>
| <a href="#W"><strong>W</strong></a>
| <a href="#Y"><strong>Y</strong></a>
</div>
<h2 id="_">_</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IPluginFactory.__call__">__call__() (certbot.interfaces.IPluginFactory method)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/errors.html#certbot.errors.AccountNotFound">AccountNotFound</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.accounts_dir">accounts_dir (certbot.interfaces.IConfig attribute)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.AccountStorage">AccountStorage (class in certbot.interfaces)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/errors.html#certbot.errors.AccountStorageError">AccountStorageError</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IReporter.add_message">add_message() (certbot.interfaces.IReporter method)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.allow_subset_of_names">allow_subset_of_names (certbot.interfaces.IConfig attribute)</a>
</dt>
<dt><a href="api/errors.html#certbot.errors.AuthorizationError">AuthorizationError</a>
</dt>
</dl></td>
</tr></table>
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.backup_dir">backup_dir (certbot.interfaces.IConfig attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/index.html#module-certbot">certbot (module)</a>
</dt>
<dt><a href="api/display.html#module-certbot.display">certbot.display (module)</a>
</dt>
<dt><a href="api/errors.html#module-certbot.errors">certbot.errors (module)</a>
</dt>
<dt><a href="api/interfaces.html#module-certbot.interfaces">certbot.interfaces (module)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IValidator.certificate">certificate() (certbot.interfaces.IValidator method)</a>
</dt>
<dt><a href="api/errors.html#certbot.errors.CertStorageError">CertStorageError</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IDisplay.checklist">checklist() (certbot.interfaces.IDisplay method)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IAuthenticator.cleanup">cleanup() (certbot.interfaces.IAuthenticator method)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.config_dir">config_dir (certbot.interfaces.IConfig attribute)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IInstaller.config_test">config_test() (certbot.interfaces.IInstaller method)</a>
</dt>
<dt><a href="api/errors.html#certbot.errors.ConfigurationError">ConfigurationError</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.csr_dir">csr_dir (certbot.interfaces.IConfig attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IInstaller.deploy_cert">deploy_cert() (certbot.interfaces.IInstaller method)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IPluginFactory.description">description (certbot.interfaces.IPluginFactory attribute)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IDisplay.directory_select">directory_select() (certbot.interfaces.IDisplay method)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.email">email (certbot.interfaces.IConfig attribute)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IInstaller.enhance">enhance() (certbot.interfaces.IInstaller method)</a>
</dt>
<dt><a href="api/errors.html#certbot.errors.Error">Error</a>
</dt>
</dl></td>
</tr></table>
<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/errors.html#certbot.errors.FailedChallenges">FailedChallenges</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.AccountStorage.find_all">find_all() (certbot.interfaces.AccountStorage method)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IInstaller.get_all_names">get_all_names() (certbot.interfaces.IInstaller method)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IAuthenticator.get_chall_pref">get_chall_pref() (certbot.interfaces.IAuthenticator method)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IReporter.HIGH_PRIORITY">HIGH_PRIORITY (certbot.interfaces.IReporter attribute)</a>
</dt>
<dt><a href="api/errors.html#certbot.errors.HookCommandNotFound">HookCommandNotFound</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IValidator.hsts">hsts() (certbot.interfaces.IValidator method)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.http01_port">http01_port (certbot.interfaces.IConfig attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IAuthenticator">IAuthenticator (interface in certbot.interfaces)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig">IConfig (interface in certbot.interfaces)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IDisplay">IDisplay (interface in certbot.interfaces)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IInstaller">IInstaller (interface in certbot.interfaces)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.in_progress_dir">in_progress_dir (certbot.interfaces.IConfig attribute)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IPluginFactory.inject_parser_options">inject_parser_options() (certbot.interfaces.IPluginFactory method)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IDisplay.input">input() (certbot.interfaces.IDisplay method)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IPlugin">IPlugin (interface in certbot.interfaces)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IPluginFactory">IPluginFactory (interface in certbot.interfaces)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IReporter">IReporter (interface in certbot.interfaces)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IValidator">IValidator (interface in certbot.interfaces)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="K">K</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.key_dir">key_dir (certbot.interfaces.IConfig attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.AccountStorage.load">load() (certbot.interfaces.AccountStorage method)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/errors.html#certbot.errors.LockError">LockError</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IReporter.LOW_PRIORITY">LOW_PRIORITY (certbot.interfaces.IReporter attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IReporter.MEDIUM_PRIORITY">MEDIUM_PRIORITY (certbot.interfaces.IReporter attribute)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IDisplay.menu">menu() (certbot.interfaces.IDisplay method)</a>
</dt>
<dt><a href="api/errors.html#certbot.errors.MisconfigurationError">MisconfigurationError</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/errors.html#certbot.errors.MissingCommandlineFlag">MissingCommandlineFlag</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IPlugin.more_info">more_info() (certbot.interfaces.IPlugin method)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.must_staple">must_staple (certbot.interfaces.IConfig attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.no_verify_ssl">no_verify_ssl (certbot.interfaces.IConfig attribute)</a>
</dt>
<dt><a href="api/errors.html#certbot.errors.NoInstallationError">NoInstallationError</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IDisplay.notification">notification() (certbot.interfaces.IDisplay method)</a>
</dt>
<dt><a href="api/errors.html#certbot.errors.NotSupportedError">NotSupportedError</a>
</dt>
</dl></td>
</tr></table>
<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IValidator.ocsp_stapling">ocsp_stapling() (certbot.interfaces.IValidator method)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IAuthenticator.perform">perform() (certbot.interfaces.IAuthenticator method)</a>
</dt>
<dt><a href="api/errors.html#certbot.errors.PluginEnhancementAlreadyPresent">PluginEnhancementAlreadyPresent</a>
</dt>
<dt><a href="api/errors.html#certbot.errors.PluginError">PluginError</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/errors.html#certbot.errors.PluginSelectionError">PluginSelectionError</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.pref_challs">pref_challs (certbot.interfaces.IConfig attribute)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IPlugin.prepare">prepare() (certbot.interfaces.IPlugin method)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IReporter.print_messages">print_messages() (certbot.interfaces.IReporter method)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IInstaller.recovery_routine">recovery_routine() (certbot.interfaces.IInstaller method)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IValidator.redirect">redirect() (certbot.interfaces.IValidator method)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IInstaller.restart">restart() (certbot.interfaces.IInstaller method)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/errors.html#certbot.errors.ReverterError">ReverterError</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IInstaller.rollback_checkpoints">rollback_checkpoints() (certbot.interfaces.IInstaller method)</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.rsa_key_size">rsa_key_size (certbot.interfaces.IConfig attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.AccountStorage.save">save() (certbot.interfaces.AccountStorage method)</a>
</dt>
<dd><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IInstaller.save">(certbot.interfaces.IInstaller method)</a>
</dt>
</dl></dd>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.server">server (certbot.interfaces.IConfig attribute)</a>
</dt>
<dt><a href="api/errors.html#certbot.errors.SignalExit">SignalExit</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/errors.html#certbot.errors.StandaloneBindError">StandaloneBindError</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.strict_permissions">strict_permissions (certbot.interfaces.IConfig attribute)</a>
</dt>
<dt><a href="api/errors.html#certbot.errors.SubprocessError">SubprocessError</a>
</dt>
<dt><a href="api/interfaces.html#certbot.interfaces.IInstaller.supported_enhancements">supported_enhancements() (certbot.interfaces.IInstaller method)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.temp_checkpoint_dir">temp_checkpoint_dir (certbot.interfaces.IConfig attribute)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.tls_sni_01_port">tls_sni_01_port (certbot.interfaces.IConfig attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IInstaller.view_config_changes">view_config_changes() (certbot.interfaces.IInstaller method)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IConfig.work_dir">work_dir (certbot.interfaces.IConfig attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="Y">Y</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="api/interfaces.html#certbot.interfaces.IDisplay.yesno">yesno() (certbot.interfaces.IDisplay method)</a>
</dt>
</dl></td>
</tr></table>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014-2016 - The Certbot software and documentation are licensed under the Apache 2.0 license as described at https://eff.org/cb-license .
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.14.2',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
