From 20abfeae74dfa6f6f4683cc2bc210cd8a5090db6 Mon Sep 17 00:00:00 2001 From: Jiri Hruska Date: Fri, 30 Aug 2013 07:29:14 +0200 Subject: [PATCH] Update README.md --- README.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 24a8033..daed0a6 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,28 @@ -# LDAP Authentication module for nginx -LDAP module for nginx which supports authentication against multiple LDAP servers. +# About this repository + +This is a fork of the original nginx LDAP HTTP authentication module with the following improvements: ++ Uses asynchronous LDAP operations through nginx's event-driven framework ++ Creates configurable number of persistent connections to each server per each worker ++ Supports configurable cache per worker process for improved performance of consecutive requests ++ Transfers only the DN when searching, not the whole entry (several KB) ++ Allows only one LDAP (bind) operation per request when the whole user DN can be composed using variables ++ Has cleaner code and debug log messages ++ Contains other minor bug fixes + +I made these changes for a project of a company I don't work for anymore and I am no longer able or willing to continue developing or maintaining the code, because I have no use for it. The project goes on (and naturally will be the next big thing!!1), but I don't know how or whether at all will my successor publish further additions or fixes. So anybody interested is welcome to fork the repository and make it into a proper stable and respected nginx module, finally. -#Warning -This module blocks whole nginx worker while communicating with ldap servers, so it can easily make "bad apache" out of your awesome nginx. But is might be useful if you don't have apache in your stack and don't want to add it, but need ldap auth on separate host (say backoffice or admin panel). +A brief TODO list, just off the top of my head: ++ Test, test, test everything and test it thoroughly. An automated test suite might be a good idea. ++ Configurable timeouts of various events, currently hardcoded ++ Some global code review after the quick and dirty development ++ Better documentation -So use carefully and consider the drawbacks. +Good luck! + +--- + +# LDAP Authentication module for nginx +LDAP module for nginx which supports authentication against multiple LDAP servers. # How to install