From aa40798d0cb3dd1250d95f48d4d792c4c9e95550 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Oudot?= Date: Mon, 2 Jun 2014 16:28:02 +0000 Subject: [PATCH] Update documentation (#26) --- doc/index/alphabetical.html | 2 +- doc/pages/documentation/1.4/applications.html | 12 +-- .../documentation/1.4/applications/nginx.html | 64 +++++++++++++++ doc/pages/documentation/1.4/portalcustom.html | 63 +++++++++------ doc/pages/documentation/1.4/register.html | 77 +++++++++++++++++++ doc/pages/documentation/1.4/start.html | 10 ++- 6 files changed, 195 insertions(+), 33 deletions(-) create mode 100644 doc/pages/documentation/1.4/applications/nginx.html create mode 100644 doc/pages/documentation/1.4/register.html diff --git a/doc/index/alphabetical.html b/doc/index/alphabetical.html index 74df99142..771ba8385 100644 --- a/doc/index/alphabetical.html +++ b/doc/index/alphabetical.html @@ -16,4 +16,4 @@ -

Alphabetical Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 

Back to main index

A

B

C

D

E

F

G

H

I

J

L

M

N

O

P

Q

R

S

T

U

V

W

Z




\ No newline at end of file +

Alphabetical Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 

Back to main index

A

B

C

D

E

F

G

H

I

J

L

M

N

O

P

Q

R

S

T

U

V

W

Z




\ No newline at end of file diff --git a/doc/pages/documentation/1.4/applications.html b/doc/pages/documentation/1.4/applications.html index 82341eedb..04c4bd1e1 100644 --- a/doc/pages/documentation/1.4/applications.html +++ b/doc/pages/documentation/1.4/applications.html @@ -130,23 +130,23 @@ Applications listed bellow are known to be easy to integrate in - + - + - + +Lutece
HTTP Auth-Basic Tomcat HTTP Auth-Basic Tomcat Nginx
Some applications using it Some applications using it
Outlook Web App
IBM Lotus iNotes
Probe
-Lutece
- +

SAML connectors

@@ -166,4 +166,4 @@ Applications listed bellow are known to be easy to integrate in
\ No newline at end of file +
\ No newline at end of file diff --git a/doc/pages/documentation/1.4/applications/nginx.html b/doc/pages/documentation/1.4/applications/nginx.html new file mode 100644 index 000000000..fa8b6ff3d --- /dev/null +++ b/doc/pages/documentation/1.4/applications/nginx.html @@ -0,0 +1,64 @@ + + + + + + + + + + + + + + + + + +
+ + + + +

Nginx LUA Handler

+
+ +

+ +

This Handler is an alternative for the Perl Nginx Handler provided in the LemonLDAP::NG project. +

+

+ +
+ +

Presentation

+
+ +

+ +Nginx is a very fast web server. The LUA API allows to write some hooks. +

+ +

+The LUA Handler for LemonLDAP::NG uses SOAP to get configuration and sessions. +

+ +
+ +

Installation

+
+ +

+ +The LUA Handler is available on GitHub: https://github.com/davidcoutadeur/lemonldap-lua-handler +

+ +

+See the README.md to know how install and configure it. + +

+ +
+
\ No newline at end of file diff --git a/doc/pages/documentation/1.4/portalcustom.html b/doc/pages/documentation/1.4/portalcustom.html index 5d310e516..b0d0cfe50 100644 --- a/doc/pages/documentation/1.4/portalcustom.html +++ b/doc/pages/documentation/1.4/portalcustom.html @@ -47,6 +47,8 @@ LemonLDAP::NG is shipped with 3 skins:
  • dark
  • +
  • bootstrap
    +
  • @@ -55,7 +57,7 @@ But you can make your own, see Skin customization below.

    - +

    Default skin

    @@ -69,7 +71,7 @@ You can change the default skin in Manager: General Parameters >

    - +

    Skin rules

    @@ -89,7 +91,7 @@ To achieve this, you can create a rule in the Manager: select General Para
    - +

    Skin files

    @@ -114,7 +116,7 @@ A skin will often refer to the common skin, which is not a real ski

    - +

    Skin customization

    @@ -175,7 +177,7 @@ To configure your new skin in Manager, select the custom skin, and enter your sk

    - +

    Error messages

    @@ -189,7 +191,7 @@ Error messages are defined in source code. If they really do not please you, ove error_0 = Big brother is watching you, authenticated user
    - +

    Template parameters

    @@ -209,14 +211,43 @@ Then you will be able to use it in your template like this:
    Hello <TMPL_VAR NAME="myparam">!
    - + +

    Buttons

    +
    + +

    + +This node allows to enable/disable buttons on the login page: +

    +
      +
    • Check last logins: displays a checkbox on login form, allowing user to check his login history right after opening session
      +
    • +
    • Reset password: display a link to reset your password page (for password based authentication backends)
      +
    • +
    • Register: display a link to register page (for password based authentication backends)
      +
    • +
    + +
    + +

    Password management

    +
    +
      +
    • Require old password: used only in the password changing module of the menu, will check the old password before updating it
      +
    • +
    • Hide old password: used only if the password need to be reset by the user (LDAP password policy), will hide the old password input
      +
    • +
    • Send mail on password change: send a mail if the password is changed from the Menu, or from forced password reset (LDAP password policy)
      +
    • +
    + +
    +

    Other parameters

    • Auto complete: allow the browser to remember the password (for password based authentication backends)
    • -
    • Check last logins: displays a checkbox on login form, allowing user to check his login history right after opening session
      -
    • User attribute: which session attribute will be used to display Connected as in the menu
    • New window: open menu links in new window
      @@ -225,18 +256,6 @@ Then you will be able to use it in your template like this:
    • Ping interval: Number of milliseconds between each ping (Ajax request) on the portal menu. Set to 0 to dismiss checks.
    • -
    • Password Management:
      -
        -
      • Reset password: display a link to reset a password (for password based authentication backends)
        -
      • -
      • Require old password: used only in the password changing module of the menu, will check the old password before updating it
        -
      • -
      • Hide old password: used only if the password need to be reset by the user (LDAP password policy), will hide the old password input
        -
      • -
      • Send mail on password change: send a mail if the password is changed from the Menu, or from forced password reset (LDAP password policy)
        -
      • -
      -

    @@ -247,4 +266,4 @@ Then you will be able to use it in your template like this:

    - \ No newline at end of file + \ No newline at end of file diff --git a/doc/pages/documentation/1.4/register.html b/doc/pages/documentation/1.4/register.html new file mode 100644 index 000000000..75f769ae7 --- /dev/null +++ b/doc/pages/documentation/1.4/register.html @@ -0,0 +1,77 @@ + + + + + + + + + + + + + + + + + +
    + + + + +

    Register a new account

    +
    + +
    + +

    Presentation

    +
    + +

    + +This feature is a page that allows a user to create an account. The steps are the following: +

    +
      +
    1. User click on the button “Create a new account”
      +
    2. +
    3. He enters first name, last name and email
      +
    4. +
    5. He gets a mail with a confirmation link
      +
    6. +
    7. After clicking, his entry is added
      +
    8. +
    9. He gets a mail with his login and his password
      +
    10. +
    + +
    + +

    Configuration

    +
    + +

    + +You can enable the “Create your account” button in portal customization parameters. +

    + +

    +Then, go in Portal > Advanced parameters > Register new account: +

    +
      +
    • Module: Choose the backend to use to create the new account.
      +
    • +
    • Page URL: URL of register page
      +
    • +
    • Validity time of a register request: duration in seconds of a new account request. The request will be deleted after this time if user do not click on the link.
      +
    • +
    • Subject for confirmation mail: Subject of the mail containing the confirmation link
      +
    • +
    • Subject for done mail: Subject of the mail giving login and password
      +
    • +
    + +
    +
    \ No newline at end of file diff --git a/doc/pages/documentation/1.4/start.html b/doc/pages/documentation/1.4/start.html index a5f584475..b8384e3f9 100644 --- a/doc/pages/documentation/1.4/start.html +++ b/doc/pages/documentation/1.4/start.html @@ -342,7 +342,7 @@ Sessions are stored using +
    @@ -362,6 +362,8 @@ Sessions are stored using +
  • +
  • @@ -381,7 +383,7 @@ Sessions are stored using +

    Mini howtos

    @@ -410,7 +412,7 @@ Sessions are stored using +

    Exploitation

    @@ -439,4 +441,4 @@ Sessions are stored using
    \ No newline at end of file +
    \ No newline at end of file