From ecce4d93427d55b92f29b8c2343deb7337c991d5 Mon Sep 17 00:00:00 2001 From: Danny Bessems Date: Fri, 22 Feb 2019 14:07:38 +0100 Subject: [PATCH] Redid formatting of README.md, taking into account Gitea's limited markdown rendering --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index bc1ffe7..c8c5c49 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,31 @@ [![](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's configuration to use the new website as forward proxy: + - #### ~~in Caddy/nginx~~ (planned for 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:" + ``` + +- #### Important! + The domainname of the website made in step 3, needs to match the domainname (*ignoring subdomains, if any*) of the resource utilizing this authentication proxy. + +## Questions or bugs +Feel free to open issues in this repository (or in its mirror on [GitHub](#)). \ No newline at end of file