Skip to main content

Clustered Webroot plugin for Let's Encrypt client

Project description

# certbot-cwebroot
Certbot plugin for clustered web servers

## Installation

* Install [certbot](https://certbot.eff.org/)
* Switch to the certbot virtualenv :

```. ~/.local/share/letsencrypt/bin/activate```

* Install `certbot-cwebroot` :

```pip install certbot-cwebroot```

## Usage

This requires that you set up your webservers (all the servers that may be
queried by the ACME server for the challenge, that is) for the webroot method,
as described [here](https://certbot.eff.org/docs/using.html#webroot).

* Get yourself an SSH key pair and deploy it on your remote hosts under the
same identity you will be using to run `certbot`.
* To use the local host as well as remote hosts `host2` and `host3`, run `certbot` like this :

```/path/to/certbot certonly --authenticator certbot-cwebroot:cwebroot -d www.example.com --certbot-cwebroot:cwebroot-path /var/www/html/letsencrypt/ --certbot-cwebroot:cwebroot-host host2 --certbot-cwebroot:cwebroot-host host3

If you don't want the challenges to be hosted locally, you can use
`--certbot-cwebroot:cwebroot-nolocal`.

* The certificate should be deployed in the usual directory (`/etc/letsencrypt`
probably) on your localhost. As this follows the use cases for the webroot
plugin (make no assumption on where the certificates should go), it is your
job to deploy the obtained certificate to your target webservers.

## How it works

The SSH connection are made with [spur](https://pypi.python.org/pypi/spur),
which is a very convenient wrapper around [Paramiko](http://www.paramiko.org/).
Spur aims to run commands locally and remotely with the same interface, so
every file system operation that whas done in the `webroot` plugin with python
functions is now run with shell commands an binaries, namely :

* `chown`
* `mkdir`
* `rm`
* `rmdir`
* `sh`
* `stat`

I have tested this on an Ubuntu 14.04, and nowhere else.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

certbot-cwebroot-0.1.0.tar.gz (6.4 kB view details)

Uploaded Source

File details

Details for the file certbot-cwebroot-0.1.0.tar.gz.

File metadata

File hashes

Hashes for certbot-cwebroot-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e072293a8523343023d347d5cb00925c35dca83a897e81972f36cda3f3c2ce07
MD5 54028bcda3771ca55d91b36d3327e288
BLAKE2b-256 5f3c44bb789560e97c01e068441abfdbe65c60d3fcb6884fe34938c252785f70

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page