Certificats Let's Encrypt
Find a file
Jakub Warmuz e7cf4792b3
Fix typos
2015-05-19 22:01:01 +00:00
acme Merge branch 'bugs/402' into pkgs_sep_prep 2015-05-10 19:18:27 +00:00
bootstrap Dockerfile: use ubuntu:trusty (based on review feedback). 2015-05-19 20:51:11 +00:00
docs Fix typos 2015-05-19 22:01:01 +00:00
examples examples: update restified 2015-05-10 13:11:51 +00:00
letsencrypt Merge remote-tracking branch 'github/letsencrypt/master' into pkgs_sep_prep 2015-05-12 20:13:50 +00:00
letsencrypt_apache Merge branch 'bugs/402' into pkgs_sep_prep 2015-05-10 17:56:41 +00:00
letsencrypt_nginx Remove unused import 2015-05-12 20:15:10 +00:00
.dockerignore .dockerignore venv and docs 2015-05-10 14:26:33 +00:00
.gitignore Revert "Update unit tests for determine_authenticator" 2015-04-22 09:02:39 +00:00
.pylintrc acme.jose: (Typed)JSONObjectWithFields, Field, JWA. 2015-03-18 14:10:28 +00:00
.travis.yml Update Travis and Vagrantfile to use sudo 2015-04-14 14:57:53 +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
CONTRIBUTING.md HTTPS ReadTheDocs link in CONTRIBUTING.md 2015-03-22 22:30:57 +00:00
docker-compose.yml Fix typos 2015-05-19 22:01:01 +00:00
Dockerfile Dockerfile: debian.sh -> ubuntu.sh 2015-05-19 21:49:57 +00:00
EULA EULA using pkg_resources (fixes #278) 2015-03-11 07:51:06 +00:00
LICENSE.txt Update LICENSE.txt for nginxparser attribution 2015-04-17 22:24:19 -07:00
linter_plugin.py acme.jose: (Typed)JSONObjectWithFields, Field, JWA. 2015-03-18 14:10:28 +00:00
MANIFEST.in Move plugins to top-level 2015-05-10 12:26:54 +00:00
README.rst Update docs to reflect nginx support 2015-05-12 12:05:17 -07:00
readthedocs.org.requirements.txt split dev_extras into dev_extras+docs_extras 2015-02-24 16:23:52 +00:00
requirements.txt Actually install ConfigArgParse@python2.6 branch 2015-05-04 12:04:27 +00:00
setup.cfg Merge branch 'bugs/402' into pkgs_sep_prep 2015-05-10 17:56:41 +00:00
setup.py tox: split test/cover per pkg 2015-05-10 12:52:40 +00:00
tox.cover.sh Merge remote-tracking branch 'github/letsencrypt/master' into pkgs_sep_prep 2015-05-12 20:13:50 +00:00
tox.ini Cover tests (fixes #402). 2015-05-10 17:38:26 +00:00
Vagrantfile setup.cfg aliases don't work with pip 2015-05-04 14:02:03 +00:00

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

|build-status| |coverage| |docs|

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 -d www.example.org auth

and if you have a compatbile web server (Apache or Nginx), Let's Encrypt can
not only get a new certificate, but also deploy it and configure your
server automatically!::

  user@www:~$ sudo letsencrypt -d www.example.org run


**Encrypt ALL the things!**


.. |build-status| image:: https://travis-ci.org/letsencrypt/lets-encrypt-preview.svg?branch=master
   :target: https://travis-ci.org/letsencrypt/lets-encrypt-preview
   :alt: Travis CI status

.. |coverage| image:: https://coveralls.io/repos/letsencrypt/lets-encrypt-preview/badge.svg?branch=master
   :target: https://coveralls.io/r/letsencrypt/lets-encrypt-preview
   :alt: Coverage status

.. |docs| image:: https://readthedocs.org/projects/letsencrypt/badge/
   :target: https://readthedocs.org/projects/letsencrypt/
   :alt: Documentation status

.. _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:

  - apache/2.x (tested and working on Ubuntu Linux)
  - nginx/0.8.48+ (tested and mostly working on Ubuntu Linux)
  - standalone (runs its own webserver to prove you control the domain)

* 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 (Apache 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

Notes for developers: CONTRIBUTING.md_

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
.. _CONTRIBUTING.md: https://github.com/letsencrypt/lets-encrypt-preview/blob/master/CONTRIBUTING.md