/usr/share/doc/python3-certbot/html/api/main.html is in python-certbot-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 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 | <!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>certbot.main — Certbot 0.23.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 0.23.0 documentation" href="../index.html"/>
<link rel="up" title="API Documentation" href="../api.html"/>
<link rel="next" title="certbot.notify" href="notify.html"/>
<link rel="prev" title="certbot.log" href="log.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.23
</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="../what.html">What is a Certificate?</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 class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="account.html"><code class="docutils literal"><span class="pre">certbot.account</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="achallenges.html"><code class="docutils literal"><span class="pre">certbot.achallenges</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="auth_handler.html"><code class="docutils literal"><span class="pre">certbot.auth_handler</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cert_manager.html"><code class="docutils literal"><span class="pre">certbot.cert_manager</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.html"><code class="docutils literal"><span class="pre">certbot.cli</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">certbot.client</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html"><code class="docutils literal"><span class="pre">certbot.configuration</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="constants.html"><code class="docutils literal"><span class="pre">certbot.constants</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="crypto_util.html"><code class="docutils literal"><span class="pre">certbot.crypto_util</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="display.html"><code class="docutils literal"><span class="pre">certbot.display</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="eff.html"><code class="docutils literal"><span class="pre">certbot.eff</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="error_handler.html"><code class="docutils literal"><span class="pre">certbot.error_handler</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="errors.html"><code class="docutils literal"><span class="pre">certbot.errors</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="hooks.html"><code class="docutils literal"><span class="pre">certbot.hooks</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">certbot</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="interfaces.html"><code class="docutils literal"><span class="pre">certbot.interfaces</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="lock.html"><code class="docutils literal"><span class="pre">certbot.lock</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="log.html"><code class="docutils literal"><span class="pre">certbot.log</span></code></a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">certbot.main</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="notify.html"><code class="docutils literal"><span class="pre">certbot.notify</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="ocsp.html"><code class="docutils literal"><span class="pre">certbot.ocsp</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/common.html"><code class="docutils literal"><span class="pre">certbot.plugins.common</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/disco.html"><code class="docutils literal"><span class="pre">certbot.plugins.disco</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/dns_common.html"><code class="docutils literal"><span class="pre">certbot.plugins.dns_common</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/dns_common_lexicon.html"><code class="docutils literal"><span class="pre">certbot.plugins.dns_common_lexicon</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/manual.html"><code class="docutils literal"><span class="pre">certbot.plugins.manual</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/selection.html"><code class="docutils literal"><span class="pre">certbot.plugins.selection</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/standalone.html"><code class="docutils literal"><span class="pre">certbot.plugins.standalone</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/util.html"><code class="docutils literal"><span class="pre">certbot.plugins.util</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/webroot.html"><code class="docutils literal"><span class="pre">certbot.plugins.webroot</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="renewal.html"><code class="docutils literal"><span class="pre">certbot.renewal</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="reporter.html"><code class="docutils literal"><span class="pre">certbot.reporter</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="reverter.html"><code class="docutils literal"><span class="pre">certbot.reverter</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="storage.html"><code class="docutils literal"><span class="pre">certbot.storage</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="util.html"><code class="docutils literal"><span class="pre">certbot.util</span></code></a></li>
</ul>
</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><a href="../api.html">API Documentation</a> »</li>
<li><code class="docutils literal"><span class="pre">certbot.main</span></code></li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/main.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="module-certbot.main">
<span id="certbot-main"></span><h1><a class="reference internal" href="#module-certbot.main" title="certbot.main"><code class="xref py py-mod docutils literal"><span class="pre">certbot.main</span></code></a><a class="headerlink" href="#module-certbot.main" title="Permalink to this headline">¶</a></h1>
<p>Certbot main entry point.</p>
<dl class="function">
<dt id="certbot.main._suggest_donation_if_appropriate">
<code class="descclassname">certbot.main.</code><code class="descname">_suggest_donation_if_appropriate</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_suggest_donation_if_appropriate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._suggest_donation_if_appropriate" title="Permalink to this definition">¶</a></dt>
<dd><p>Potentially suggest a donation to support Certbot.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._report_successful_dry_run">
<code class="descclassname">certbot.main.</code><code class="descname">_report_successful_dry_run</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_report_successful_dry_run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._report_successful_dry_run" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports on successful dry run</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._get_and_save_cert">
<code class="descclassname">certbot.main.</code><code class="descname">_get_and_save_cert</code><span class="sig-paren">(</span><em>le_client</em>, <em>config</em>, <em>domains=None</em>, <em>certname=None</em>, <em>lineage=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_get_and_save_cert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._get_and_save_cert" title="Permalink to this definition">¶</a></dt>
<dd><p>Authenticate and enroll certificate.</p>
<p>This method finds the relevant lineage, figures out what to do with it,
then performs that action. Includes calls to hooks, various reports,
checks, and requests for user input.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>domains</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of domain names to get a certificate. Defaults to <code class="xref py py-obj docutils literal"><span class="pre">None</span></code></li>
<li><strong>certname</strong> (<em>str</em>) – Name of new certificate. Defaults to <code class="xref py py-obj docutils literal"><span class="pre">None</span></code></li>
<li><strong>lineage</strong> (<a class="reference internal" href="storage.html#certbot.storage.RenewableCert" title="certbot.storage.RenewableCert"><em>storage.RenewableCert</em></a>) – Certificate lineage object. Defaults to <code class="xref py py-obj docutils literal"><span class="pre">None</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the issued certificate or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if doing a dry run</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="storage.html#certbot.storage.RenewableCert" title="certbot.storage.RenewableCert">storage.RenewableCert</a> or None</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="errors.html#certbot.errors.Error" title="certbot.errors.Error"><strong>errors.Error</strong></a> – if certificate could not be obtained</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._handle_subset_cert_request">
<code class="descclassname">certbot.main.</code><code class="descname">_handle_subset_cert_request</code><span class="sig-paren">(</span><em>config</em>, <em>domains</em>, <em>cert</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_handle_subset_cert_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._handle_subset_cert_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Figure out what to do if a previous cert had a subset of the names now requested</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>domains</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of domain names</li>
<li><strong>cert</strong> (<a class="reference internal" href="storage.html#certbot.storage.RenewableCert" title="certbot.storage.RenewableCert"><em>storage.RenewableCert</em></a>) – Certificate object</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Tuple of (str action, cert_or_None) as per _find_lineage_for_domains_and_certname
action can be: “newcert” | “renew” | “reinstall”</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal"><span class="pre">tuple</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._handle_identical_cert_request">
<code class="descclassname">certbot.main.</code><code class="descname">_handle_identical_cert_request</code><span class="sig-paren">(</span><em>config</em>, <em>lineage</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_handle_identical_cert_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._handle_identical_cert_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Figure out what to do if a lineage has the same names as a previously obtained one</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>lineage</strong> (<a class="reference internal" href="storage.html#certbot.storage.RenewableCert" title="certbot.storage.RenewableCert"><em>storage.RenewableCert</em></a>) – Certificate lineage object</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Tuple of (str action, cert_or_None) as per _find_lineage_for_domains_and_certname
action can be: “newcert” | “renew” | “reinstall”</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal"><span class="pre">tuple</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._find_lineage_for_domains">
<code class="descclassname">certbot.main.</code><code class="descname">_find_lineage_for_domains</code><span class="sig-paren">(</span><em>config</em>, <em>domains</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_find_lineage_for_domains"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._find_lineage_for_domains" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine whether there are duplicated names and how to handle
them (renew, reinstall, newcert, or raising an error to stop
the client run if the user chooses to cancel the operation when
prompted).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>domains</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of domain names</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Two-element tuple containing desired new-certificate behavior as
a string token (“reinstall”, “renew”, or “newcert”), plus either
a RenewableCert instance or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if renewal shouldn’t occur.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">tuple</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal"><span class="pre">storage.RenewableCert</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="errors.html#certbot.errors.Error" title="certbot.errors.Error"><strong>errors.Error</strong></a> – If the user would like to rerun the client again.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._find_cert">
<code class="descclassname">certbot.main.</code><code class="descname">_find_cert</code><span class="sig-paren">(</span><em>config</em>, <em>domains</em>, <em>certname</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_find_cert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._find_cert" title="Permalink to this definition">¶</a></dt>
<dd><p>Finds an existing certificate object given domains and/or a certificate name.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>domains</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of domain names</li>
<li><strong>certname</strong> (<em>str</em>) – Name of certificate</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Two-element tuple of a boolean that indicates if this function should be
followed by a call to fetch a certificate from the server, and either a
RenewableCert instance or None.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal"><span class="pre">tuple</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">bool</span></code> and <code class="xref py py-class docutils literal"><span class="pre">storage.RenewableCert</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._find_lineage_for_domains_and_certname">
<code class="descclassname">certbot.main.</code><code class="descname">_find_lineage_for_domains_and_certname</code><span class="sig-paren">(</span><em>config</em>, <em>domains</em>, <em>certname</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_find_lineage_for_domains_and_certname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._find_lineage_for_domains_and_certname" title="Permalink to this definition">¶</a></dt>
<dd><p>Find appropriate lineage based on given domains and/or certname.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>domains</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of domain names</li>
<li><strong>certname</strong> (<em>str</em>) – Name of certificate</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Two-element tuple containing desired new-certificate behavior as
a string token (“reinstall”, “renew”, or “newcert”), plus either
a RenewableCert instance or None if renewal should not occur.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">tuple</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal"><span class="pre">storage.RenewableCert</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="errors.html#certbot.errors.Error" title="certbot.errors.Error"><strong>errors.Error</strong></a> – If the user would like to rerun the client again.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._get_added_removed">
<code class="descclassname">certbot.main.</code><code class="descname">_get_added_removed</code><span class="sig-paren">(</span><em>after</em>, <em>before</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_get_added_removed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._get_added_removed" title="Permalink to this definition">¶</a></dt>
<dd><p>Get lists of items removed from <code class="xref py py-obj docutils literal"><span class="pre">before</span></code>
and a lists of items added to <code class="xref py py-obj docutils literal"><span class="pre">after</span></code></p>
</dd></dl>
<dl class="function">
<dt id="certbot.main._format_list">
<code class="descclassname">certbot.main.</code><code class="descname">_format_list</code><span class="sig-paren">(</span><em>character</em>, <em>strings</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_format_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._format_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Format list with given character</p>
</dd></dl>
<dl class="function">
<dt id="certbot.main._ask_user_to_confirm_new_names">
<code class="descclassname">certbot.main.</code><code class="descname">_ask_user_to_confirm_new_names</code><span class="sig-paren">(</span><em>config</em>, <em>new_domains</em>, <em>certname</em>, <em>old_domains</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_ask_user_to_confirm_new_names"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._ask_user_to_confirm_new_names" title="Permalink to this definition">¶</a></dt>
<dd><p>Ask user to confirm update cert certname to contain new_domains.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>new_domains</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of new domain names</li>
<li><strong>certname</strong> (<em>str</em>) – Name of certificate</li>
<li><strong>old_domains</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of old domain names</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="errors.html#certbot.errors.ConfigurationError" title="certbot.errors.ConfigurationError"><strong>errors.ConfigurationError</strong></a> – if cert name and domains mismatch</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._find_domains_or_certname">
<code class="descclassname">certbot.main.</code><code class="descname">_find_domains_or_certname</code><span class="sig-paren">(</span><em>config</em>, <em>installer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_find_domains_or_certname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._find_domains_or_certname" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve domains and certname from config or user input.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>installer</strong> (<em>interfaces.IInstaller</em>) – Installer object</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Two-part tuple of domains and certname</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">tuple</span></code> of list of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code> and <code class="xref py py-obj docutils literal"><span class="pre">str</span></code></p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="errors.html#certbot.errors.Error" title="certbot.errors.Error"><strong>errors.Error</strong></a> – Usage message, if parameters are not used correctly</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._report_new_cert">
<code class="descclassname">certbot.main.</code><code class="descname">_report_new_cert</code><span class="sig-paren">(</span><em>config</em>, <em>cert_path</em>, <em>fullchain_path</em>, <em>key_path=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_report_new_cert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._report_new_cert" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports the creation of a new certificate to the user.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>cert_path</strong> (<em>str</em>) – path to certificate</li>
<li><strong>fullchain_path</strong> (<em>str</em>) – path to full chain</li>
<li><strong>key_path</strong> (<em>str</em>) – path to private key, if available</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._determine_account">
<code class="descclassname">certbot.main.</code><code class="descname">_determine_account</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_determine_account"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._determine_account" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine which account to use.</p>
<p>In order to make the renewer (configuration de/serialization) happy,
if <code class="docutils literal"><span class="pre">config.account</span></code> is <code class="docutils literal"><span class="pre">None</span></code>, it will be updated based on the
user input. Same for <code class="docutils literal"><span class="pre">config.email</span></code>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Account and optionally ACME client API (biproduct of new
registration).</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">tuple of <a class="reference internal" href="account.html#certbot.account.Account" title="certbot.account.Account"><code class="xref py py-class docutils literal"><span class="pre">certbot.account.Account</span></code></a> and <code class="xref py py-class docutils literal"><span class="pre">acme.client.Client</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="errors.html#certbot.errors.Error" title="certbot.errors.Error"><strong>errors.Error</strong></a> – If unable to register an account with ACME server</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._delete_if_appropriate">
<code class="descclassname">certbot.main.</code><code class="descname">_delete_if_appropriate</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_delete_if_appropriate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._delete_if_appropriate" title="Permalink to this definition">¶</a></dt>
<dd><p>Does the user want to delete their now-revoked certs? If run in non-interactive mode,
deleting happens automatically, unless if both <code class="xref py py-obj docutils literal"><span class="pre">--cert-name</span></code> and <code class="xref py py-obj docutils literal"><span class="pre">--cert-path</span></code> were
specified with conflicting values.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<em>interfaces.IConfig</em>) – parsed command line arguments</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="errors.html#certbot.errors.Error" title="certbot.errors.Error"><strong>errors.Error</strong></a> – If anything goes wrong, including bad user input, if an overlapping
archive dir is found for the specified lineage, etc …</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._init_le_client">
<code class="descclassname">certbot.main.</code><code class="descname">_init_le_client</code><span class="sig-paren">(</span><em>config</em>, <em>authenticator</em>, <em>installer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_init_le_client"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._init_le_client" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize Let’s Encrypt Client</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>authenticator</strong> (<em>interfaces.IAuthenticator</em>) – Acme authentication handler</li>
<li><strong>installer</strong> (<em>interfaces.IInstaller</em>) – Installer object</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">client: Client object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="client.html#certbot.client.Client" title="certbot.client.Client">client.Client</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.unregister">
<code class="descclassname">certbot.main.</code><code class="descname">unregister</code><span class="sig-paren">(</span><em>config</em>, <em>unused_plugins</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#unregister"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.unregister" title="Permalink to this definition">¶</a></dt>
<dd><p>Deactivate account on server</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>unused_plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins (deprecated)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.register">
<code class="descclassname">certbot.main.</code><code class="descname">register</code><span class="sig-paren">(</span><em>config</em>, <em>unused_plugins</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#register"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.register" title="Permalink to this definition">¶</a></dt>
<dd><p>Create or modify accounts on the server.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>unused_plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins (deprecated)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code> or a string indicating and error</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None or str</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._install_cert">
<code class="descclassname">certbot.main.</code><code class="descname">_install_cert</code><span class="sig-paren">(</span><em>config</em>, <em>le_client</em>, <em>domains</em>, <em>lineage=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_install_cert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._install_cert" title="Permalink to this definition">¶</a></dt>
<dd><p>Install a cert</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>le_client</strong> (<a class="reference internal" href="client.html#certbot.client.Client" title="certbot.client.Client"><em>client.Client</em></a>) – Client object</li>
<li><strong>plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of domains</li>
<li><strong>lineage</strong> (<a class="reference internal" href="storage.html#certbot.storage.RenewableCert" title="certbot.storage.RenewableCert"><em>storage.RenewableCert</em></a>) – Certificate lineage object. Defaults to <code class="xref py py-obj docutils literal"><span class="pre">None</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.install">
<code class="descclassname">certbot.main.</code><code class="descname">install</code><span class="sig-paren">(</span><em>config</em>, <em>plugins</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#install"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.install" title="Permalink to this definition">¶</a></dt>
<dd><p>Install a previously obtained cert in a server.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._populate_from_certname">
<code class="descclassname">certbot.main.</code><code class="descname">_populate_from_certname</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_populate_from_certname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._populate_from_certname" title="Permalink to this definition">¶</a></dt>
<dd><p>Helper function for install to populate missing config values from lineage
defined by –cert-name.</p>
</dd></dl>
<dl class="function">
<dt id="certbot.main.plugins_cmd">
<code class="descclassname">certbot.main.</code><code class="descname">plugins_cmd</code><span class="sig-paren">(</span><em>config</em>, <em>plugins</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#plugins_cmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.plugins_cmd" title="Permalink to this definition">¶</a></dt>
<dd><p>List server software plugins.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.rollback">
<code class="descclassname">certbot.main.</code><code class="descname">rollback</code><span class="sig-paren">(</span><em>config</em>, <em>plugins</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#rollback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.rollback" title="Permalink to this definition">¶</a></dt>
<dd><p>Rollback server configuration changes made during install.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.config_changes">
<code class="descclassname">certbot.main.</code><code class="descname">config_changes</code><span class="sig-paren">(</span><em>config</em>, <em>unused_plugins</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#config_changes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.config_changes" title="Permalink to this definition">¶</a></dt>
<dd><p>Show changes made to server config during installation</p>
<p>View checkpoints and associated configuration changes.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>unused_plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins (deprecated)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.update_symlinks">
<code class="descclassname">certbot.main.</code><code class="descname">update_symlinks</code><span class="sig-paren">(</span><em>config</em>, <em>unused_plugins</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#update_symlinks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.update_symlinks" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the certificate file family symlinks</p>
<p>Use the information in the config file to make symlinks point to
the correct archive directory.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>unused_plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins (deprecated)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.rename">
<code class="descclassname">certbot.main.</code><code class="descname">rename</code><span class="sig-paren">(</span><em>config</em>, <em>unused_plugins</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#rename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.rename" title="Permalink to this definition">¶</a></dt>
<dd><p>Rename a certificate</p>
<p>Use the information in the config file to rename an existing
lineage.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>unused_plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins (deprecated)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.delete">
<code class="descclassname">certbot.main.</code><code class="descname">delete</code><span class="sig-paren">(</span><em>config</em>, <em>unused_plugins</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a certificate</p>
<p>Use the information in the config file to delete an existing
lineage.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>unused_plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins (deprecated)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.certificates">
<code class="descclassname">certbot.main.</code><code class="descname">certificates</code><span class="sig-paren">(</span><em>config</em>, <em>unused_plugins</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#certificates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.certificates" title="Permalink to this definition">¶</a></dt>
<dd><p>Display information about certs configured with Certbot</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>unused_plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins (deprecated)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.revoke">
<code class="descclassname">certbot.main.</code><code class="descname">revoke</code><span class="sig-paren">(</span><em>config</em>, <em>unused_plugins</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#revoke"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.revoke" title="Permalink to this definition">¶</a></dt>
<dd><p>Revoke a previously obtained certificate.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>unused_plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins (deprecated)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code> or string indicating error in case of error</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None or str</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.run">
<code class="descclassname">certbot.main.</code><code class="descname">run</code><span class="sig-paren">(</span><em>config</em>, <em>plugins</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.run" title="Permalink to this definition">¶</a></dt>
<dd><p>Obtain a certificate and install.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main._csr_get_and_save_cert">
<code class="descclassname">certbot.main.</code><code class="descname">_csr_get_and_save_cert</code><span class="sig-paren">(</span><em>config</em>, <em>le_client</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#_csr_get_and_save_cert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main._csr_get_and_save_cert" title="Permalink to this definition">¶</a></dt>
<dd><p>Obtain a cert using a user-supplied CSR</p>
<p>This works differently in the CSR case (for now) because we don’t
have the privkey, and therefore can’t construct the files for a lineage.
So we just save the cert & chain to disk :/</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>client</strong> (<a class="reference internal" href="client.html#certbot.client.Client" title="certbot.client.Client"><em>client.Client</em></a>) – Client object</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">cert_path</span></code> and <code class="xref py py-obj docutils literal"><span class="pre">fullchain_path</span></code> as absolute paths to the actual files</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal"><span class="pre">tuple</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.renew_cert">
<code class="descclassname">certbot.main.</code><code class="descname">renew_cert</code><span class="sig-paren">(</span><em>config</em>, <em>plugins</em>, <em>lineage</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#renew_cert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.renew_cert" title="Permalink to this definition">¶</a></dt>
<dd><p>Renew & save an existing cert. Do not install it.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins</li>
<li><strong>lineage</strong> (<a class="reference internal" href="storage.html#certbot.storage.RenewableCert" title="certbot.storage.RenewableCert"><em>storage.RenewableCert</em></a>) – Certificate lineage object</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="errors.html#certbot.errors.PluginSelectionError" title="certbot.errors.PluginSelectionError"><strong>errors.PluginSelectionError</strong></a> – MissingCommandlineFlag if supplied parameters do not pass</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.certonly">
<code class="descclassname">certbot.main.</code><code class="descname">certonly</code><span class="sig-paren">(</span><em>config</em>, <em>plugins</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#certonly"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.certonly" title="Permalink to this definition">¶</a></dt>
<dd><p>Authenticate & obtain cert, but do not install it.</p>
<p>This implements the ‘certonly’ subcommand.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="errors.html#certbot.errors.Error" title="certbot.errors.Error"><strong>errors.Error</strong></a> – If specified plugin could not be used</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.renew">
<code class="descclassname">certbot.main.</code><code class="descname">renew</code><span class="sig-paren">(</span><em>config</em>, <em>unused_plugins</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#renew"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.renew" title="Permalink to this definition">¶</a></dt>
<dd><p>Renew previously-obtained certificates.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</li>
<li><strong>unused_plugins</strong> (<code class="xref py py-obj docutils literal"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>) – List of plugins (deprecated)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.make_or_verify_needed_dirs">
<code class="descclassname">certbot.main.</code><code class="descname">make_or_verify_needed_dirs</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#make_or_verify_needed_dirs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.make_or_verify_needed_dirs" title="Permalink to this definition">¶</a></dt>
<dd><p>Create or verify existence of config, work, and hook directories.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.set_displayer">
<code class="descclassname">certbot.main.</code><code class="descname">set_displayer</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#set_displayer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.set_displayer" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the displayer</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<em>interfaces.IConfig</em>) – Configuration object</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="certbot.main.main">
<code class="descclassname">certbot.main.</code><code class="descname">main</code><span class="sig-paren">(</span><em>cli_args=['-N', '-bhtml', 'docs/', 'build/html']</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/main.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.main.main" title="Permalink to this definition">¶</a></dt>
<dd><p>Command line argument parsing and main script execution.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">result of requested command</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><a class="reference internal" href="errors.html#certbot.errors.Error" title="certbot.errors.Error"><strong>errors.Error</strong></a> – OS errors triggered by wrong permissions</li>
<li><a class="reference internal" href="errors.html#certbot.errors.Error" title="certbot.errors.Error"><strong>errors.Error</strong></a> – error if plugin command is not supported</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="notify.html" class="btn btn-neutral float-right" title="certbot.notify" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="log.html" class="btn btn-neutral" title="certbot.log" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<span class="copyright">
© Copyright 2014-2018 - The Certbot software and documentation are licensed under the Apache 2.0 license as described at <a href="https://eff.org/cb-license">https://eff.org/cb-license</a>.
</span>
<br>
<br>
<span class="status">
<a href="https://letsencrypt.status.io/">Let's Encrypt Status</a>
</span>
</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.23.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>
|