summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMaarten de Waard <maarten@greenhost.nl>2016-11-01 09:55:08 (GMT)
committerMaarten de Waard <maarten@greenhost.nl>2016-11-01 09:55:08 (GMT)
commite119197ee9e792173c2bce58cf589d6eeef9f392 (patch)
treedaf8d0892d1941273de7603b28f7c6fe6b12b0bf
parent50b1f3ffa702c3bc1ba75d0b42bf155fa66794e5 (diff)
downloadcertbot-haproxy-e119197ee9e792173c2bce58cf589d6eeef9f392.zip
certbot-haproxy-e119197ee9e792173c2bce58cf589d6eeef9f392.tar.gz
certbot-haproxy-e119197ee9e792173c2bce58cf589d6eeef9f392.tar.bz2
README updated
-rw-r--r--README.rst32
-rw-r--r--setup.py2
2 files changed, 32 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index f61a124..1f33837 100644
--- a/README.rst
+++ b/README.rst
@@ -3,12 +3,37 @@ HAProxy plugin for Certbot
.. contents:: Table of Contents
+About
+-----
+
+This is a certbot plugin for using certbot in combination with a HAProxy setup.
+Its advantage over using the standalone certbot is that it automatically places
+certificates in the correct directory and restarts HAProxy afterwards. It should
+also enable you to very easily do automatic certificate renewal.
+
+Furthermore, you can configure HAProxy to handle Boulder's authentication using
+the HAProxy authenticator of this plugin.
+
+It was created for use with `Greenhost`_'s share hosting environment and can be
+useful to you in the following cases:
+
+- If you use HAProxy and have several domains for which you want to enable Let's
+ Encrypt certificates
+- If you yourself have a shared hosting platform that uses HAProxy to redirect
+ to your client's websites
+- Actually any case in which you want to automatically restart HAProxy after you
+ request a new certificate.
+
+.. _Greenhost: https://greenhost.net
+
+Please read the installation instructions on how to configure HAProxy.
+
Installing: Requirements
------------------------
Currently this plugin has been tested on Debian Jessie, but it will most likely
work on Ubuntu 14.04+ too. If you are running Debian Wheezy, you may need to
-take additional steps during the installation.
+take additional steps during the installation. Thus, the requirements are:
- Debian Jessie (or higher) or Ubuntu Trusty (or higher).
- Python 2.7 (2.6 is supported by certbot and our goal is to be compatible but
@@ -424,6 +449,10 @@ you can update.
Making a `.deb` debian package
------------------------------
+Requirements:
+
+ - python stdeb: pip install --upgrade stdeb
+ - dh clean: apt-get install dh-make
Run the following commands in your vagrant machine:
@@ -436,5 +465,6 @@ Run the following commands in your vagrant machine:
py2dsc certbot-haproxy-<version>.tar.gz
cd deb_dist/certbot-haproxy-<version>
# NOTE: Not signed, no signed changes (with -uc and -us)
+ # NOTE: Add the package to the ghtools repo
dpkg-buildpackage -rfakeroot -uc -us
```
diff --git a/setup.py b/setup.py
index 7ed9a24..e299c63 100644
--- a/setup.py
+++ b/setup.py
@@ -3,7 +3,7 @@ import sys
from setuptools import setup
from setuptools import find_packages
-own_version = '0.1.0'
+own_version = '0.1.1'
certbot_version = '0.8.1'
# Please update tox.ini when modifying dependency version requirements