From aa31950b4394a05f9395c87bbba9e9b8a9b1f9c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Oudot?= Date: Wed, 19 Feb 2014 15:42:12 +0000 Subject: [PATCH] Update documentation (#636) --- doc/pages/documentation/1.4/authdbi.html | 16 ++++++++++--- doc/pages/documentation/1.4/authdemo.html | 5 +++- doc/pages/documentation/1.4/authfacebook.html | 4 ++++ doc/pages/documentation/1.4/authgoogle.html | 4 ++++ doc/pages/documentation/1.4/authldap.html | 24 +++++++++++++------ doc/pages/documentation/1.4/authopenid.html | 8 ++++++- doc/pages/documentation/1.4/authslave.html | 8 ++++++- doc/pages/documentation/1.4/authwebid.html | 13 ++++++---- doc/pages/documentation/1.4/exportedvars.html | 13 ++++++++-- doc/pages/documentation/1.4/start.html | 4 ++-- 10 files changed, 78 insertions(+), 21 deletions(-) diff --git a/doc/pages/documentation/1.4/authdbi.html b/doc/pages/documentation/1.4/authdbi.html index 5568ee3a0..93c881cc3 100644 --- a/doc/pages/documentation/1.4/authdbi.html +++ b/doc/pages/documentation/1.4/authdbi.html @@ -215,6 +215,16 @@ As DBI is a login/password based m +

Exported variables

+
+ +

+ +List of columns to query to fill user session. See also exported variables configuration. +

+ +
+

Connection

@@ -234,7 +244,7 @@ As DBI is a login/password based m
- +

Schema

- +

Password

- \ No newline at end of file + \ No newline at end of file diff --git a/doc/pages/documentation/1.4/authdemo.html b/doc/pages/documentation/1.4/authdemo.html index 20a67971e..35527d538 100644 --- a/doc/pages/documentation/1.4/authdemo.html +++ b/doc/pages/documentation/1.4/authdemo.html @@ -84,8 +84,11 @@ The AuthDemo and UserDBDemo will allow you to log in and get the standard attrib

-There is nothing more to do that select the backend in the Manager. +Select Demonstration for authentication, user and password backend. +

+

+You can also modify list of exported variables. Only uid, cn and mail attributes are available. See also exported variables configuration.

diff --git a/doc/pages/documentation/1.4/authfacebook.html b/doc/pages/documentation/1.4/authfacebook.html index 4a3755224..75c65ca00 100644 --- a/doc/pages/documentation/1.4/authfacebook.html +++ b/doc/pages/documentation/1.4/authfacebook.html @@ -86,6 +86,10 @@ If you use Facebook as user database, declare values in exported variables :

+See also exported variables configuration. +

+ +

You can use the same Facebook access token in your applications. It is stored in session datas under the name $_facebookToken

diff --git a/doc/pages/documentation/1.4/authgoogle.html b/doc/pages/documentation/1.4/authgoogle.html index 175e923de..c962548fc 100644 --- a/doc/pages/documentation/1.4/authgoogle.html +++ b/doc/pages/documentation/1.4/authgoogle.html @@ -78,6 +78,10 @@ Use the name you want but this values in the value field. If you want to require

+See also exported variables configuration. +

+ +

A specific persistent session is created with this module, to store attribute values returned by Google. If this session is lost, Google will ask a confirmation for each requested attribute.

diff --git a/doc/pages/documentation/1.4/authldap.html b/doc/pages/documentation/1.4/authldap.html index 188e2bf3f..a8afdb55d 100644 --- a/doc/pages/documentation/1.4/authldap.html +++ b/doc/pages/documentation/1.4/authldap.html @@ -114,6 +114,16 @@ As LDAP is a lo +

Exported variables

+
+ +

+ +List of attributes to query to fill user session. See also exported variables configuration. +

+ +
+

Connection

- +

Filters

@@ -189,7 +199,7 @@ And the mail filter is:

- +

Groups

- +

Password

- +

Schema extension

@@ -260,7 +270,7 @@ Of course, standard LDAP<

- +

OID prefix

@@ -273,7 +283,7 @@ The prefix 1.3.6.1.4.1.10943 is owned by
- +

OpenLDAP schema

@@ -314,4 +324,4 @@ You can add this object class to any entry of your directory.

- \ No newline at end of file + \ No newline at end of file diff --git a/doc/pages/documentation/1.4/authopenid.html b/doc/pages/documentation/1.4/authopenid.html index 271318771..d643bbc6f 100644 --- a/doc/pages/documentation/1.4/authopenid.html +++ b/doc/pages/documentation/1.4/authopenid.html @@ -95,7 +95,7 @@ Then, go in OpenID parameters:

-To configure requested attributes, go in Variables > Exported variables and define attributes: +To configure requested attributes, edit Exported variables and define attributes:

+

+ +See also exported variables configuration. + +

+ \ No newline at end of file diff --git a/doc/pages/documentation/1.4/authslave.html b/doc/pages/documentation/1.4/authslave.html index fcff6f76f..15cb253f8 100644 --- a/doc/pages/documentation/1.4/authslave.html +++ b/doc/pages/documentation/1.4/authslave.html @@ -79,7 +79,7 @@ Then, go in Slave parameters:

-You have then to declare HTTP headers exported by the main SSO (in “Variables » Exported Variables”). Example : +You have then to declare HTTP headers exported by the main SSO (in Exported Variables). Example :

@@ -94,5 +94,11 @@ You have then to declare HTTP
+

+ +See also exported variables configuration. + +

+ \ No newline at end of file diff --git a/doc/pages/documentation/1.4/authwebid.html b/doc/pages/documentation/1.4/authwebid.html index 8e592ae8c..f6dca4deb 100644 --- a/doc/pages/documentation/1.4/authwebid.html +++ b/doc/pages/documentation/1.4/authwebid.html @@ -70,7 +70,7 @@ Then, go in WebID parameters:

-If you use WebID as user database, declare values in exported variables : +If you use WebID as user database, declare values in exported variables :

+

+ +See also exported variables configuration. +

+ - +

Apache configuration

@@ -102,7 +107,7 @@ SSLVerifyClient optional_no_ca
- +

Tests

@@ -120,4 +125,4 @@ To test this, you can build your own WebID certificate using one of :
- \ No newline at end of file + \ No newline at end of file diff --git a/doc/pages/documentation/1.4/exportedvars.html b/doc/pages/documentation/1.4/exportedvars.html index 518ce1b44..dee0f62d5 100644 --- a/doc/pages/documentation/1.4/exportedvars.html +++ b/doc/pages/documentation/1.4/exportedvars.html @@ -59,11 +59,20 @@ Examples for +You can define exported variables for each module in the module configuration itself. Variables defined in the main Exported variables will be used for each backend. Variables defined in the exported variables node of the module will be used only for that module. +

+ +

+

You can define environment variables in Exported variables, this allows to populate user session with some environment values. Environment variables will not be queried in users database. +

+

+ +

Exported variables in the Manager

- +

Extend variables using macros and groups

@@ -118,4 +127,4 @@ Besides, macros and groups are computed in alphanumeric order, that is, in the o
-
\ No newline at end of file +
\ 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 e0fe8d25a..a5f584475 100644 --- a/doc/pages/documentation/1.4/start.html +++ b/doc/pages/documentation/1.4/start.html @@ -22,11 +22,11 @@ -

Documentation for LemonLDAP::NG 1.3

+

Documentation for LemonLDAP::NG 1.4

- +

Installation