From 6d2d93cf2589fd92772e7a34ace57df0805ea6be Mon Sep 17 00:00:00 2001 From: Danny Bessems Date: Fri, 22 Feb 2019 14:07:38 +0100 Subject: [PATCH] Added rudimentary documentation (#3) --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index bc1ffe7..22e3d00 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,28 @@ [![](https://img.shields.io/badge/status-in%20production-%23003399.svg)](#) [![](https://img.shields.io/badge/contributors-1-green.svg) ](#) Forward Authentication for use with proxies (caddy, nginx, traefik, etc) + +## Usage +- Create a new folder, navigate to it in a commandprompt and run the following command: + `git clone https://code.spamasaurus.com/djpbessems/lucidAuth.git` +- Edit `include/lucidAuth.config.php.example` to reflect your configuration and save as `include/lucidAuth.config.php` +- Create a new website (within any php-capable webserver) and make sure that the documentroot points to the `public` folder +- Check if you are able to browse to `https:///lucidAuth.login.php` (where `` is the actual domain -or IP address- your webserver is listening on) +- Edit your proxy to use the new website as forward proxy: +#### in Caddy/nginx +*will come at a later stage* +#### in Traefik +Add the following lines (change to reflect your existing configuration): +``` + [frontends.server1] + entrypoints = ["https"] + backend = "server1" + [frontends.server1.auth.forward] + address = "https:///lucidAuth.validateRequest.php" + [frontends.server1.routes] + [frontends.server1.routes.ext] + rule = "Host:" +``` + +## Questions or bugs +Feel free to open issues in this repository (or in its mirror on [GitHub](#)). \ No newline at end of file