upstream/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-03-02 21:30:46 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
Certificats Let's Encrypt
1404 commits 847 branches 153 tags 122 MiB
Python 94.5%
Shell 3.7%
Batchfile 0.8%
Makefile 0.7%
Augeas 0.2%
Find a file
James Kasten 08fc0852d7 Correct display docs
2015-02-18 04:13:49 -08:00
docs Correct display docs 2015-02-18 04:13:49 -08:00
letsencrypt Merge branch 'master' into revoker 2015-02-18 04:04:07 -08:00
.gitignore gitignore: .coverage is a file 2014-11-27 22:49:15 +01:00
.pylintrc Merge remote-tracking branch 'github/letsencrypt/master' into acme 2015-02-10 00:00:54 +00:00
.travis.yml Simpler Travis CI matrix 2015-01-28 12:56:12 +00:00
CHANGES.rst docs: markup fixes, separate section for api docs, link to demo video, improved phrasing 2015-01-26 14:58:24 +01:00
EULA Random small changes 2014-12-01 03:05:06 -08:00
letsencrypt.py letsencrypt.py as setuptools console script 2014-11-19 13:29:02 +01:00
LICENSE.txt Remove Unneccesary How To 2014-11-18 13:08:09 -08:00
linter_plugin.py Add comment int linter_plugin 2015-02-15 11:49:07 +00:00
MANIFEST.in Add linter_plugin.py to MANIFEST.in 2015-02-08 12:47:21 +00:00
README.rst update intro paragraph of README 2015-01-27 14:41:23 -08:00
requirements.txt Declare dependency on PyOpenSSL package 2015-02-02 17:02:22 -08:00
setup.cfg No pylint in py2.6 tox 2015-02-06 23:41:28 +00:00
setup.py Merge branch 'master' into revoker 2015-02-18 03:36:53 -08:00
tox.ini Finish revoker implementation and unittests 2015-02-18 04:01:49 -08:00

README.rst 

About the Let's Encrypt Client
==============================

In short: getting and installing SSL/TLS certificates made easy (`watch demo video`_).

The Let's Encrypt Client is a tool to automatically receive and install
X.509 certificates to enable TLS on servers. The client will
interoperate with the Let's Encrypt CA which will be issuing browser-trusted
certificates for free beginning the summer of 2015.

It's all automated:

* The tool will prove domain control to the CA and submit a CSR (Certificate
  Signing Request).
* If domain control has been proven, a certificate will get issued and the tool
  will automatically install it.

All you need to do is:

::

   user@www:~$ sudo letsencrypt www.example.org


**Encrypt ALL the things!**


.. image:: https://travis-ci.org/letsencrypt/lets-encrypt-preview.svg?branch=master
    :target: https://travis-ci.org/letsencrypt/lets-encrypt-preview

.. _watch demo video: https://www.youtube.com/watch?v=Gas_sSB-5SU


Disclaimer
----------

This is a **DEVELOPER PREVIEW** intended for developers and testers only.

**DO NOT RUN THIS CODE ON A PRODUCTION SERVER. IT WILL INSTALL CERTIFICATES
SIGNED BY A TEST CA, AND WILL CAUSE CERT WARNINGS FOR USERS.**


Current Features
----------------

* web servers supported:

  - apache2.x (tested and working on Ubuntu Linux)

* the private key is generated locally on your system
* can talk to the Let's Encrypt (demo) CA or optionally to other ACME
  compliant services
* can get domain-validated (DV) certificates
* can revoke certificates
* adjustable RSA key bitlength (2048 (default), 4096, ...)
* optionally can install a http->https redirect, so your site effectively
  runs https only
* fully automated
* configuration changes are logged and can be reverted using the CLI
* text and ncurses UI
* Free and Open Source Software, made with Python.


Links
-----

Documentation: https://letsencrypt.readthedocs.org/

Software project: https://github.com/letsencrypt/lets-encrypt-preview

Main Website: https://letsencrypt.org/

IRC Channel: #letsencrypt on `Freenode`_

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

.. _Freenode: https://freenode.net
.. _client-dev: https://groups.google.com/a/letsencrypt.org/forum/#!forum/client-dev