Certbot, previously the Let's Encrypt Client, is EFF's tool to obtain certs from Let's Encrypt, and (optionally) auto-enable HTTPS on your server. It can also act as a client for any other CA that uses the ACME protocol.
Python Shell Nginx ApacheConf Makefile Batchfile Other
Latest commit fe35860 Jan 18, 2017 @dashaxiong dashaxiong committed with bmw Add cleanup trap to integration test script (#4075)
The integration test script spins up Python webservers. This trap will
ensure that those webservers are shutdown at exit.
Permalink
Failed to load latest commit information.
acme Impelment account deactivation [revision requested] (#3571) Jan 18, 2017
certbot-apache Fix misspelling "recieved" (#4059) Jan 17, 2017
certbot-compatibility-test encode to bytes as necessary in Validator.certificate (#4026) Jan 17, 2017
certbot-nginx Release 0.10.0 (#4022) Jan 11, 2017
certbot Enable Py36 Tests (#3972) Jan 18, 2017
docs Merge pull request #4042 from pconrad-fb/master Jan 18, 2017
examples Rename misc files Apr 14, 2016
letsencrypt-auto-source certbot-auto re-installs virtualenv when plugin is causing issues (#4035 Jan 17, 2017
letshelp-certbot Bump version to 0.7.0 May 12, 2016
tests Add cleanup trap to integration test script (#4075) Jan 18, 2017
tools Remove the sphinxcontrib.programout [docs]dependency (#3830) Nov 30, 2016
.coveragerc Show lines missing test coverage in test output Jun 17, 2016
.dockerignore Update ignore files to remove shared tox.venv Jul 12, 2015
.gitattributes Merge pull request #2136 from tboegi/gitattributes_eol_overrideses_auto Jun 16, 2016
.gitignore Impelment account deactivation [revision requested] (#3571) Jan 18, 2017
.pep8 nit: fix missing EOF newline Sep 6, 2015
.pylintrc Adopt consistent linting practices for the entire tree (#3843) Jan 17, 2017
.travis.yml Enable Py36 Tests (#3972) Jan 18, 2017
CHANGES.rst Improve CHANGES.rst. (#3541) Sep 27, 2016
CONTRIBUTING.md Update CONTRIBUTING.md to be more welcoming. (#3540) Sep 26, 2016
Dockerfile Error/Warning with build docker container from Dockerfile (#3004) May 18, 2016
Dockerfile-dev More stray ncrypt reference cleanup Apr 15, 2016
LICENSE.txt More stray ncrypt reference cleanup Apr 15, 2016
MANIFEST.in Rename misc files Apr 14, 2016
README.rst I restructured Installation and Using a bit (#3725) Nov 1, 2016
Vagrantfile Remove the curses dialog, thereby deprecating the --help and --dialog… Oct 21, 2016
certbot-auto Candidate 0.10.1 to master (#4057) Jan 14, 2017
docker-compose.yml Rename misc files Apr 14, 2016
letsencrypt-auto Candidate 0.10.1 to master (#4057) Jan 14, 2017
linter_plugin.py Rename misc files Apr 14, 2016
pep8.travis.sh Improve user experience for linting. Jun 5, 2016
readthedocs.org.requirements.txt RTD: install local deps for subpkgs (fixes #1086). Oct 23, 2015
setup.cfg setup.cfg Apr 15, 2016
setup.py Merge the manual and script plugins (#3890) Dec 22, 2016
tox.cover.sh Serialize coverage tests (#3919) Dec 21, 2016
tox.ini Enable Py36 Tests (#3972) Jan 18, 2017

README.rst

Certbot is part of EFF’s effort to encrypt the entire Internet. Secure communication over the Web relies on HTTPS, which requires the use of a digital certificate that lets browsers verify the identify of web servers (e.g., is that really google.com?). Web servers obtain their certificates from trusted third parties called certificate authorities (CAs). Certbot is an easy-to-use client that fetches a certificate from Let’s Encrypt—an open certificate authority launched by the EFF, Mozilla, and others—and deploys it to a web server.

Anyone who has gone through the trouble of setting up a secure website knows what a hassle getting and maintaining a certificate is. Certbot and Let’s Encrypt can automate away the pain and let you turn on and manage HTTPS with simple commands. Using Certbot and Let's Encrypt is free, so there’s no need to arrange payment.

How you use Certbot depends on the configuration of your web server. The best way to get started is to use our interactive guide. It generates instructions based on your configuration settings. In most cases, you’ll need root or administrator access to your web server to run Certbot.

If you’re using a hosted service and don’t have direct access to your web server, you might not be able to use Certbot. Check with your hosting provider for documentation about uploading certificates or using certificates issues by Let’s Encrypt.

Certbot is a fully-featured, extensible client for the Let's Encrypt CA (or any other CA that speaks the ACME protocol) that can automate the tasks of obtaining certificates and configuring webservers to use them. This client runs on Unix-based operating systems.

Until May 2016, Certbot was named simply letsencrypt or letsencrypt-auto, depending on install method. Instructions on the Internet, and some pieces of the software, may still refer to this older name.

Contributing

If you'd like to contribute to this project please read Developer Guide.

Installation

The easiest way to install Certbot is by visiting certbot.eff.org, where you can find the correct installation instructions for many web server and OS combinations. For more information, see Get Certbot.

How to run the client

In many cases, you can just run certbot-auto or certbot, and the client will guide you through the process of obtaining and installing certs interactively.

For full command line help, you can type:

./certbot-auto --help all

You can also tell it exactly what you want it to do from the command line. For instance, if you want to obtain a cert for example.com, www.example.com, and other.example.net, using the Apache plugin to both obtain and install the certs, you could do this:

./certbot-auto --apache -d example.com -d www.example.com -d other.example.net

(The first time you run the command, it will make an account, and ask for an email and agreement to the Let's Encrypt Subscriber Agreement; you can automate those with --email and --agree-tos)

If you want to use a webserver that doesn't have full plugin support yet, you can still use "standalone" or "webroot" plugins to obtain a certificate:

./certbot-auto certonly --standalone --email admin@example.com -d example.com -d www.example.com -d other.example.net

Understanding the client in more depth

To understand what the client is doing in detail, it's important to understand the way it uses plugins. Please see the explanation of plugins in the User Guide.

Links

Documentation: https://certbot.eff.org/docs

Software project: https://github.com/certbot/certbot

Notes for developers: https://certbot.eff.org/docs/contributing.html

Main Website: https://certbot.eff.org

Let's Encrypt Website: https://letsencrypt.org

IRC Channel: #letsencrypt on Freenode or #certbot on OFTC

Community: https://community.letsencrypt.org

ACME spec: http://ietf-wg-acme.github.io/acme/

ACME working area in github: https://github.com/ietf-wg-acme/acme

Mailing list: client-dev (to subscribe without a Google account, send an email to client-dev+subscribe@letsencrypt.org)

Travis CI status Coverage status Documentation status Docker Repository on Quay.io

System Requirements

The Let's Encrypt Client presently only runs on Unix-ish OSes that include Python 2.6 or 2.7; Python 3.x support will hopefully be added in the future. The client requires root access in order to write to /etc/letsencrypt, /var/log/letsencrypt, /var/lib/letsencrypt; to bind to ports 80 and 443 (if you use the standalone plugin) and to read and modify webserver configurations (if you use the apache or nginx plugins). If none of these apply to you, it is theoretically possible to run without root privileges, but for most users who want to avoid running an ACME client as root, either letsencrypt-nosudo or simp_le are more appropriate choices.

The Apache plugin currently requires a Debian-based OS with augeas version 1.0; this includes Ubuntu 12.04+ and Debian 7+.

Current Features

  • Supports multiple web servers:
    • apache/2.x (beta support for auto-configuration)
    • nginx/0.8.48+ (alpha support for auto-configuration)
    • webroot (adds files to webroot directories in order to prove control of domains and obtain certs)
    • standalone (runs its own simple webserver to prove you control a domain)
    • other server software via third party plugins
  • The private key is generated locally on your system.
  • Can talk to the Let's Encrypt CA or optionally to other ACME compliant services.
  • Can get domain-validated (DV) certificates.
  • Can revoke certificates.
  • Adjustable RSA key bit-length (2048 (default), 4096, ...).
  • Can optionally install a http -> https redirect, so your site effectively runs https only (Apache only)
  • Fully automated.
  • Configuration changes are logged and can be reverted.
  • Supports ncurses and text (-t) UI, or can be driven entirely from the command line.
  • Free and Open Source Software, made with Python.

For extensive documentation on using and contributing to Certbot, go to https://certbot.eff.org/docs. If you would like to contribute to the project or run the latest code from git, you should read our developer guide.