git.sesse.net Git - letsencrypt-varnish-plugin/blob - 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 certbot as usual.
  15
  16  2. Activate the venv, if installed in a venv:
  17
  18     . ~/.local/share/certbot/bin/activate
  19
  20  3. Install the module:
  21
  22     pip3 install -e path/to/this/certbot-hitch
  23
  24  4. Ask for a certificate:
  25
  26     sudo certbot -a certbot-varnish:varnish -d <domain> certonly
  27
  28
  29 Varnish itself does not support SSL, so the module is just for authentication,
  30 just installation. There is a Hitch installation module at
  31
  32   https://git.sesse.net/?p=letsencrypt-hitch-plugin;a=summary
  33
  34 The Varnish authenticator plugin is licensed under the same terms as the Let's
  35 Encrypt client itself.
  36
  37   - Steinar H. Gunderson <steinar+letsencrypt@gunderson.no>