/usr/share/doc/python3-certbot-dns-route53/html/index.html is in python-certbot-dns-route53-doc 0.23.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 | <!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>Welcome to certbot-dns-route53’s documentation! — certbot-dns-route53 0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="certbot-dns-route53 0 documentation" href="#"/>
<link rel="next" title="API Documentation" href="api.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="#" class="icon icon-home"> certbot-dns-route53
</a>
<div class="version">
0
</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="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="#">certbot-dns-route53</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="#">Docs</a> »</li>
<li>Welcome to certbot-dns-route53’s documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="welcome-to-certbot-dns-route53-s-documentation">
<h1>Welcome to certbot-dns-route53’s documentation!<a class="headerlink" href="#welcome-to-certbot-dns-route53-s-documentation" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-certbot_dns_route53"></span><p>The <a class="reference internal" href="api/dns_route53.html#module-certbot_dns_route53.dns_route53" title="certbot_dns_route53.dns_route53"><code class="xref py py-obj docutils literal"><span class="pre">dns_route53</span></code></a> plugin automates the process of
completing a <code class="docutils literal"><span class="pre">dns-01</span></code> challenge (<code class="xref py py-obj docutils literal"><span class="pre">DNS01</span></code>) by creating, and
subsequently removing, TXT records using the Amazon Web Services Route 53 API.</p>
<div class="section" id="named-arguments">
<h2>Named Arguments<a class="headerlink" href="#named-arguments" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="52%" />
<col width="48%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">--dns-route53-propagation-seconds</span></code></td>
<td>The number of seconds to wait for DNS
to propagate before asking the ACME
server to verify the DNS record.
(Default: 10)</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="credentials">
<h2>Credentials<a class="headerlink" href="#credentials" title="Permalink to this headline">¶</a></h2>
<p>Use of this plugin requires a configuration file containing Amazon Web Sevices
API credentials for an account with the following permissions:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">route53:ListHostedZones</span></code></li>
<li><code class="docutils literal"><span class="pre">route53:GetChange</span></code></li>
<li><code class="docutils literal"><span class="pre">route53:ChangeResourceRecordSets</span></code></li>
</ul>
<p>These permissions can be captured in an AWS policy like the one below. Amazon
provides <a class="reference external" href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/access-control-overview.html">information about managing access</a> and <a class="reference external" href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/r53-api-permissions-ref.html">information about
the required permissions</a></p>
<div class="literal-block-wrapper docutils container" id="sample-aws-policy-json">
<div class="code-block-caption"><span class="caption-text">Example AWS policy file:</span><a class="headerlink" href="#sample-aws-policy-json" title="Permalink to this code">¶</a></div>
<div class="highlight-json"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="nt">"Version"</span><span class="p">:</span> <span class="s2">"2012-10-17"</span><span class="p">,</span>
<span class="nt">"Id"</span><span class="p">:</span> <span class="s2">"certbot-dns-route53 sample policy"</span><span class="p">,</span>
<span class="nt">"Statement"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="nt">"Effect"</span><span class="p">:</span> <span class="s2">"Allow"</span><span class="p">,</span>
<span class="nt">"Action"</span><span class="p">:</span> <span class="p">[</span>
<span class="s2">"route53:ListHostedZones"</span><span class="p">,</span>
<span class="s2">"route53:GetChange"</span>
<span class="p">],</span>
<span class="nt">"Resource"</span><span class="p">:</span> <span class="p">[</span>
<span class="s2">"*"</span>
<span class="p">]</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="nt">"Effect"</span> <span class="p">:</span> <span class="s2">"Allow"</span><span class="p">,</span>
<span class="nt">"Action"</span> <span class="p">:</span> <span class="p">[</span>
<span class="s2">"route53:ChangeResourceRecordSets"</span>
<span class="p">],</span>
<span class="nt">"Resource"</span> <span class="p">:</span> <span class="p">[</span>
<span class="s2">"arn:aws:route53:::hostedzone/YOURHOSTEDZONEID"</span>
<span class="p">]</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<p>The <a class="reference external" href="https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys">access keys</a> for an account
with these permissions must be supplied in one of the following ways, which are
discussed in more detail in the Boto3 library’s documentation about <a class="reference external" href="https://boto3.readthedocs.io/en/latest/guide/configuration.html#best-practices-for-configuring-credentials">configuring
credentials</a>.</p>
<ul class="simple">
<li>Using the <code class="docutils literal"><span class="pre">AWS_ACCESS_KEY_ID</span></code> and <code class="docutils literal"><span class="pre">AWS_SECRET_ACCESS_KEY</span></code> environment
variables.</li>
<li>Using a credentials configuration file at the default location,
<code class="docutils literal"><span class="pre">~/.aws/config</span></code>.</li>
<li>Using a credentials configuration file at a path supplied using the
<code class="docutils literal"><span class="pre">AWS_CONFIG_FILE</span></code> environment variable.</li>
</ul>
<div class="literal-block-wrapper docutils container" id="config-ini">
<div class="code-block-caption"><span class="caption-text">Example credentials config file:</span><a class="headerlink" href="#config-ini" title="Permalink to this code">¶</a></div>
<div class="highlight-ini"><div class="highlight"><pre><span></span><span class="k">[default]</span>
<span class="na">aws_access_key_id</span><span class="o">=</span><span class="s">AKIAIOSFODNN7EXAMPLE</span>
<span class="na">aws_secret_access_key</span><span class="o">=</span><span class="s">wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY</span>
</pre></div>
</div>
</div>
<div class="admonition caution">
<p class="first admonition-title">Caution</p>
<p class="last">You should protect these API credentials as you would a password. Users who
can read this file can use these credentials to issue some types of API calls
on your behalf, limited by the permissions assigned to the account. Users who
can cause Certbot to run using these credentials can complete a <code class="docutils literal"><span class="pre">dns-01</span></code>
challenge to acquire new certificates or revoke existing certificates for
domains these credentials are authorized to manage.</p>
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<div class="literal-block-wrapper docutils container" id="id1">
<div class="code-block-caption"><span class="caption-text">To acquire a certificate for <code class="docutils literal"><span class="pre">example.com</span></code></span><a class="headerlink" href="#id1" title="Permalink to this code">¶</a></div>
<div class="highlight-bash"><div class="highlight"><pre><span></span>certbot certonly <span class="se">\</span>
--dns-route53 <span class="se">\</span>
-d example.com
</pre></div>
</div>
</div>
<div class="literal-block-wrapper docutils container" id="id2">
<div class="code-block-caption"><span class="caption-text">To acquire a single certificate for both <code class="docutils literal"><span class="pre">example.com</span></code> and
<code class="docutils literal"><span class="pre">www.example.com</span></code></span><a class="headerlink" href="#id2" title="Permalink to this code">¶</a></div>
<div class="highlight-bash"><div class="highlight"><pre><span></span>certbot certonly <span class="se">\</span>
--dns-route53 <span class="se">\</span>
-d example.com <span class="se">\</span>
-d www.example.com
</pre></div>
</div>
</div>
<div class="literal-block-wrapper docutils container" id="id3">
<div class="code-block-caption"><span class="caption-text">To acquire a certificate for <code class="docutils literal"><span class="pre">example.com</span></code>, waiting 30 seconds
for DNS propagation</span><a class="headerlink" href="#id3" title="Permalink to this code">¶</a></div>
<div class="highlight-bash"><div class="highlight"><pre><span></span>certbot certonly <span class="se">\</span>
--dns-route53 <span class="se">\</span>
--dns-route53-propagation-seconds <span class="m">30</span> <span class="se">\</span>
-d example.com
</pre></div>
</div>
</div>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="api.html" class="btn btn-neutral float-right" title="API Documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Certbot Project.
</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',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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>
|