certbot

mirror of https://github.com/certbot/certbot.git synced 2026-02-20 08:20:44 -05:00

Certificats Let's Encrypt

Find a file

Jakub Warmuz dfd7e142c1 Do not use xunit. coverage instead of xcoverage.		2014-11-27 20:56:35 +01:00
letsencrypt	Merge pull request #87 from letsencrypt/proper_documentation	2014-11-27 01:32:46 -08:00
.gitignore	Use tox for tests	2014-11-22 15:04:36 +01:00
EULA	Changed EULA to Yes/No to Agree/Disagree	2014-11-19 17:01:30 -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
MANIFEST.in	Clean MANIFEST.in	2014-11-22 15:05:44 +01:00
README.md	Refactored command line code to use argparse.	2014-11-26 21:09:45 -05:00
requirements.txt	Refactored command line code to use argparse.	2014-11-26 21:09:45 -05:00
setup.cfg	Add missing newline at end of file	2014-11-22 15:14:14 +01:00
setup.py	Test coverage	2014-11-27 20:30:56 +01:00
tox.ini	Do not use xunit. coverage instead of xcoverage.	2014-11-27 20:56:35 +01:00

README.md

This is the Let's Encrypt Agent DEVELOPER PREVIEW repository.

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

This code is intended for testing, demonstration, and integration engineering with OSes and hosting platforms. Currently the code works with Linux and Apache, though we will be expanding it to other platforms.

Running the demo code on Ubuntu

sudo apt-get install python python-setuptools python-virtualenv \
  python-dev gcc swig dialog libaugeas0 libssl-dev
virtualenv --no-site-packages venv
./venv/bin/python setup.py install
sudo ./venv/bin/letsencrypt

Note, that letsencrypt does not yet handle Debian unstable's Apache2 conf layout.

Hacking

Bootstrap: ./venv/bin/python setup.py dev
Test code base: ./venv/bin/tox

Command line usage

usage: sudo letsencrypt.py [-h] [-d DOMAIN [DOMAIN ...]] [-s SERVER] [-p PRIVKEY]
                      [-c CSR] [-b ROLLBACK] [-k] [-v] [-r] [-n] [-e] [-t]
                      [--test]

An ACME client that can update Apache configurations.

optional arguments:
  -h, --help            show this help message and exit
  -d DOMAIN [DOMAIN ...], --domains DOMAIN [DOMAIN ...]
  -s SERVER, --server SERVER
                        The ACME CA server address.
  -p PRIVKEY, --privkey PRIVKEY
                        Path to the private key file for certificate
                        generation.
  -c CSR, --csr CSR     Path to the certificate signing request file
                        corresponding to the private key file. The private key
                        file argument is required if this argument is
                        specified.
  -b ROLLBACK, --rollback ROLLBACK
                        Revert configuration <ROLLBACK> number of checkpoints.
  -k, --revoke          Revoke a certificate.
  -v, --view-checkpoints
                        View checkpoints and associated configuration changes.
  -r, --redirect        Automatically redirect all HTTP traffic to HTTPS for
                        the newly authenticated vhost.
  -n, --no-redirect     Skip the HTTPS redirect question, allowing both HTTP
                        and HTTPS.
  -e, --agree-eula      Skip the end user license agreement screen.
  -t, --text            Use the text output instead of the curses UI.
  --test                Run in test mode.

More Information

Further Setup, documentation and open projects are available in the [Wiki] (https://github.com/letsencrypt/lets-encrypt-preview/wiki)

Join us at our IRC channel @ freenode.net #letsencrypt

Client software development can be discussed on this [mailing list] (https://groups.google.com/a/letsencrypt.org/forum/#!forum/client-dev)

To subscribe without a Google account, send mail to [client-dev+subscribe@letsencrypt.org] (mailto:client-dev+subscribe@letsencrypt.org).