No description
Find a file
Jacob Hoffman-Andrews 22b8446efb Get precompiled Goose from GithHub.
Rather than fetching from bitbucket and building. Bitbucket is often down, and
building from scratch is slow. Github is sometimes down, but at least now we
have our eggs in one basket.
2015-10-15 14:32:52 -07:00
acme Add rateLimited error type. 2015-10-14 09:26:59 -07:00
bootstrap Disable nginx in bootstrap/venv.sh too 2015-10-15 00:09:42 -07:00
docs Move augeaus & venv references 2015-10-15 00:07:26 -07:00
examples agree-tos in dev-cli.ini 2015-09-26 11:07:54 +00:00
letsencrypt Date only because hard to do time with no time 2015-10-14 22:53:36 -07:00
letsencrypt-apache Merge pull request #949 from kuba/bugs/838 2015-10-13 14:38:17 -04:00
letsencrypt-compatibility-test Merge pull request #950 from letsencrypt/jsha/nginx-improvements 2015-10-12 16:41:52 -07:00
letsencrypt-nginx Replace lambda with comprehension. 2015-10-11 12:30:02 -07:00
letshelp-letsencrypt Release 0.0.0.dev20151008 2015-10-08 19:28:55 +00:00
tests Get precompiled Goose from GithHub. 2015-10-15 14:32:52 -07:00
tools Require tests pass in dev release. 2015-10-11 10:52:08 +00:00
.dockerignore Update ignore files to remove shared tox.venv 2015-07-12 15:30:51 +00:00
.gitignore Simple dev release script 2015-09-27 16:12:50 +00:00
.pep8 nit: fix missing EOF newline 2015-09-06 09:27:39 +00:00
.pylintrc Disable pylint invalid-name 2015-09-30 12:10:16 -07:00
.travis.yml Limit Travis runs to master and PRs. 2015-10-10 13:31:35 -07:00
CHANGES.rst Update references after repo rename. 2015-06-24 04:56:31 +00:00
CONTRIBUTING.md HTTPS ReadTheDocs link in CONTRIBUTING.md 2015-03-22 22:30:57 +00:00
docker-compose.yml Use a discrete path for venv in docker, rather than /opt/letsencrypt. 2015-05-19 17:39:53 -07:00
Dockerfile Dockerfile: option --text doesn't exist 2015-09-28 17:34:43 +02:00
Dockerfile-dev Update Dockerfile-dev and instructions. 2015-09-21 15:33:40 -07:00
EULA EULA using pkg_resources (fixes #278) 2015-03-11 07:51:06 +00:00
letsencrypt-auto Try to make the dependencies link work 2015-10-15 00:03:49 -07:00
LICENSE.txt Make sure the LICENSE file is accurate for first pre-relase 2015-09-30 19:23:17 -07:00
linter_plugin.py acme.jose: (Typed)JSONObjectWithFields, Field, JWA. 2015-03-18 14:10:28 +00:00
MANIFEST.in Add docs to tarballs (fixes #884). 2015-10-07 22:40:02 +00:00
pep8.travis.sh Travis: no fail on pep8 2015-09-11 07:12:49 +00:00
README.rst Updated README to reflect state of Nginx plugin 2015-10-01 10:12:38 -07:00
readthedocs.org.requirements.txt Add API docs for letsencrypt_compatibility_test 2015-10-04 06:37:35 +00:00
requirements.txt requirements.txt: no editable (-e) mode, no "." install. 2015-06-09 07:51:42 +00:00
setup.cfg Merge branch 'bugs/402' into pkgs_sep_prep 2015-05-10 17:56:41 +00:00
setup.py Merge remote-tracking branch 'github/letsencrypt/master' into mock-2.6 2015-10-05 19:31:05 +00:00
tox.cover.sh Bump core coverage to 98% 2015-10-06 18:58:06 +00:00
tox.ini Don't run tox for temporarily-disabled python versions 2015-09-15 19:01:55 -07:00
Vagrantfile Update package references after subdirs rename. 2015-07-11 04:33:07 +00:00

.. notice for github users

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.**

Browser-trusted certificates will be available in the coming months.

For more information regarding the status of the project, please see
https://letsencrypt.org. Be sure to checkout the
`Frequently Asked Questions (FAQ) <https://community.letsencrypt.org/t/frequently-asked-questions-faq/26#topic-title>`_.

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

|build-status| |coverage| |docs| |container|

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.

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 to sign a single domain is::

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

For multiple domains (SAN) use::

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

and if you have a compatible 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/letsencrypt.svg?branch=master
   :target: https://travis-ci.org/letsencrypt/letsencrypt
   :alt: Travis CI status

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

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

.. |container| image:: https://quay.io/repository/letsencrypt/letsencrypt/status
   :target: https://quay.io/repository/letsencrypt/letsencrypt
   :alt: Docker Repository on Quay.io

.. _`installation instructions`:
   https://letsencrypt.readthedocs.org/en/latest/using.html

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


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

* web servers supported:

  - apache/2.x (tested and working on Ubuntu Linux)
  - nginx/0.8.48+ (under development)
  - 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.


Installation Instructions
-------------------------

Official **documentation**, including `installation instructions`_, is
available at https://letsencrypt.readthedocs.org.


Links
-----

Documentation: https://letsencrypt.readthedocs.org

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

Notes for developers: CONTRIBUTING.md_

Main Website: https://letsencrypt.org/

IRC Channel: #letsencrypt on `Freenode`_

Community: https://community.letsencrypt.org

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/letsencrypt/blob/master/CONTRIBUTING.md