Initial checkin.
[letsencrypt-varnish-plugin] / README
1 This is a Let's Encrypt authenticator module for authenticating any site
2 that Varnish sits in front of. The most obvious use would be if you have
3 some sort of backend CMS that's not easy to get to serve arbitrary files,
4 or if you have some sort of complicated rewriting in place in your VCL.
5 It works by rewriting your VCL file to intercept the http-01 auth requests
6 and synthesizing the responses.
7
8 The code is ugly, has tons of lint errors and relies on a number of assumptions
9 (such as your VCL being in /etc/default/varnish.vcl). Patches accepted to clean
10 it up. Please back up your VCL configuratoin before use.
11
12 To use:
13
14  1. Install letsencrypt as usual, with letsencrypt-auto.
15
16  2. Activate the venv:
17
18     . ~/.local/share/letsencrypt/bin/activate
19
20  3. Install the module:
21
22     pip install -e path/to/this/letsencrypt-varnish
23
24  4. Ask for a certificate:
25
26     sudo ~/.local/share/letsencrypt/bin/letsencrypt --agree-dev-preview --server https://acme-v01.api.letsencrypt.org/directory -a letsencrypt-varnish-plugin:varnish -d <domain> certonly  
27
28
29 There is no installation module, since Varnish itself does not support SSL.
30 If there's enough interest, I might make a hitch installation module to go
31 with the Varnish authenticator module.
32
33 The Varnish authenticator plugin is licensed under the same terms as the Let's
34 Encrypt client itself.
35
36   - Steinar H. Gunderson <steinar+letsencrypt@gunderson.no>