dani/lemonldap-ng
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation (#636)

Browse Source
This commit is contained in:
Clément Oudot 2014-02-19 15:42:12 +00:00
parent ab4dfe1100
commit aa31950b43
10 changed files with 78 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/pages/documentation/1.4/authdbi.html
View File

@ -215,6 +215,16 @@ As <acronym title="Database Interface">DBI</acronym> is a login/password based m
</div>
<!-- SECTION "Authentication level" [2016-2380] -->
<h3><a name="exported_variables" id="exported_variables">Exported variables</a></h3>
<div class="level3">
<p>
List of columns to query to fill user session. See also <a href="../../documentation/1.4/exportedvars.html" class="wikilink1" title="documentation:1.4:exportedvars">exported variables configuration</a>.
</p>
</div>
<!-- SECTION "Exported variables" [2381-2518] -->
<h3><a name="connection" id="connection">Connection</a></h3>
<div class="level3">
@ -234,7 +244,7 @@ As <acronym title="Database Interface">DBI</acronym> is a login/password based m
</ul>
</div>
<!-- SECTION "Connection" [2381-2895] -->
<!-- SECTION "Connection" [2519-3033] -->
<h3><a name="schema1" id="schema1">Schema</a></h3>
<div class="level3">
<ul>
@ -253,7 +263,7 @@ As <acronym title="Database Interface">DBI</acronym> is a login/password based m
</ul>
</div>
<!-- SECTION "Schema" [2896-3339] -->
<!-- SECTION "Schema" [3034-3477] -->
<h3><a name="password" id="password">Password</a></h3>
<div class="level3">
<ul>
@ -262,4 +272,4 @@ As <acronym title="Database Interface">DBI</acronym> is a login/password based m
</ul>
</div>
<!-- SECTION "Password" [3340-] --></div><!-- closes <div class="dokuwiki export">-->
<!-- SECTION "Password" [3478-] --></div><!-- closes <div class="dokuwiki export">-->

5
doc/pages/documentation/1.4/authdemo.html
View File

@ -84,8 +84,11 @@ The AuthDemo and UserDBDemo will allow you to log in and get the standard attrib
<p>
There is nothing more to do that select the backend in the Manager.
Select Demonstration for authentication, user and password backend.
</p>
<p>
You can also modify list of exported variables. Only uid, cn and mail attributes are available. See also <a href="../../documentation/1.4/exportedvars.html" class="wikilink1" title="documentation:1.4:exportedvars">exported variables configuration</a>.
</p>
</div>

4
doc/pages/documentation/1.4/authfacebook.html
View File

@ -86,6 +86,10 @@ If you use Facebook as user database, declare values in exported variables :
<p>
See also <a href="../../documentation/1.4/exportedvars.html" class="wikilink1" title="documentation:1.4:exportedvars">exported variables configuration</a>.
</p>
<p>
<p><div class="notetip">You can use the same Facebook access token in your applications. It is stored in session datas under the name <strong>$_facebookToken</strong>
</div></p>

4
doc/pages/documentation/1.4/authgoogle.html
View File

@ -78,6 +78,10 @@ Use the name you want but this values in the value field. If you want to require
<p>
See also <a href="../../documentation/1.4/exportedvars.html" class="wikilink1" title="documentation:1.4:exportedvars">exported variables configuration</a>.
</p>
<p>
<p><div class="noteimportant">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.
</div></p>

24
doc/pages/documentation/1.4/authldap.html
View File

@ -114,6 +114,16 @@ As <acronym title="Lightweight Directory Access Protocol">LDAP</acronym> is a lo
</div>
<!-- SECTION "Authentication level" [1163-1528] -->
<h3><a name="exported_variables" id="exported_variables">Exported variables</a></h3>
<div class="level3">
<p>
List of attributes to query to fill user session. See also <a href="../../documentation/1.4/exportedvars.html" class="wikilink1" title="documentation:1.4:exportedvars">exported variables configuration</a>.
</p>
</div>
<!-- SECTION "Exported variables" [1529-1669] -->
<h3><a name="connection" id="connection">Connection</a></h3>
<div class="level3">
<ul>
@ -144,7 +154,7 @@ As <acronym title="Lightweight Directory Access Protocol">LDAP</acronym> is a lo
</ul>
</div>
<!-- SECTION "Connection" [1529-2720] -->
<!-- SECTION "Connection" [1670-2861] -->
<h3><a name="filters" id="filters">Filters</a></h3>
<div class="level3">
@ -189,7 +199,7 @@ And the mail filter is:
</p>
</div>
<!-- SECTION "Filters" [2721-3367] -->
<!-- SECTION "Filters" [2862-3508] -->
<h3><a name="groups" id="groups">Groups</a></h3>
<div class="level3">
<ul>
@ -210,7 +220,7 @@ And the mail filter is:
</ul>
</div>
<!-- SECTION "Groups" [3368-4202] -->
<!-- SECTION "Groups" [3509-4343] -->
<h3><a name="password" id="password">Password</a></h3>
<div class="level3">
<ul>
@ -231,7 +241,7 @@ And the mail filter is:
</ul>
</div>
<!-- SECTION "Password" [4203-5191] -->
<!-- SECTION "Password" [4344-5332] -->
<h2><a name="schema_extension" id="schema_extension">Schema extension</a></h2>
<div class="level2">
@ -260,7 +270,7 @@ Of course, standard <acronym title="Lightweight Directory Access Protocol">LDAP<
</p>
</div>
<!-- SECTION "Schema extension" [5192-5855] -->
<!-- SECTION "Schema extension" [5333-5996] -->
<h3><a name="oid_prefix" id="oid_prefix">OID prefix</a></h3>
<div class="level3">
@ -273,7 +283,7 @@ The prefix 1.3.6.1.4.1.10943 is owned by <a href="http://www.linagora.com" class
</p>
</div>
<!-- SECTION "OID prefix" [5856-6100] -->
<!-- SECTION "OID prefix" [5997-6241] -->
<h3><a name="openldap_schema" id="openldap_schema">OpenLDAP schema</a></h3>
<div class="level3">
@ -314,4 +324,4 @@ You can add this object class to any entry of your directory.
</p>
</div>
<!-- SECTION "OpenLDAP schema" [6101-] --></div><!-- closes <div class="dokuwiki export">-->
<!-- SECTION "OpenLDAP schema" [6242-] --></div><!-- closes <div class="dokuwiki export">-->

8
doc/pages/documentation/1.4/authopenid.html
View File

@ -95,7 +95,7 @@ Then, go in <code>OpenID parameters</code>:
<p>
To configure requested attributes, go in <code>Variables</code> &gt; <code>Exported variables</code> and define attributes:
To configure requested attributes, edit <strong>Exported variables</strong> and define attributes:
</p>
<ul>
<li class="level1"><div class="li"> <strong>Key</strong>: internal session key, can be prefixed by <code>!</code> to make the attribute required</div>
@ -124,5 +124,11 @@ To configure requested attributes, go in <code>Variables</code> &gt; <code>Expor
</li>
</ul>
<p>
See also <a href="../../documentation/1.4/exportedvars.html" class="wikilink1" title="documentation:1.4:exportedvars">exported variables configuration</a>.
</p>
</div>
<!-- SECTION "Configuration" [827-] --></div><!-- closes <div class="dokuwiki export">-->

8
doc/pages/documentation/1.4/authslave.html
View File

@ -79,7 +79,7 @@ Then, go in <code>Slave parameters</code>:
<p>
You have then to declare <acronym title="Hyper Text Transfer Protocol">HTTP</acronym> headers exported by the main <acronym title="Single Sign On">SSO</acronym> (in “Variables » Exported Variables”). Example :
You have then to declare <acronym title="Hyper Text Transfer Protocol">HTTP</acronym> headers exported by the main <acronym title="Single Sign On">SSO</acronym> (in <strong>Exported Variables</strong>). Example :
</p>
<table class="inline">
@ -94,5 +94,11 @@ You have then to declare <acronym title="Hyper Text Transfer Protocol">HTTP</acr
</tr>
</table>
<p>
See also <a href="../../documentation/1.4/exportedvars.html" class="wikilink1" title="documentation:1.4:exportedvars">exported variables configuration</a>.
</p>
</div>
<!-- SECTION "Configuration" [547-] --></div><!-- closes <div class="dokuwiki export">-->

13
doc/pages/documentation/1.4/authwebid.html
View File

@ -70,7 +70,7 @@ Then, go in <code>WebID parameters</code>:
<p>
If you use WebID as user database, declare values in exported variables :
If you use WebID as user database, declare values in <strong>exported variables</strong> :
</p>
<ul>
<li class="level1"><div class="li"> use any key name you want. If you want to refuse access when a data is missing, just add a ”!” before the key name</div>
@ -80,8 +80,13 @@ If you use WebID as user database, declare values in exported variables :
</li>
</ul>
<p>
See also <a href="../../documentation/1.4/exportedvars.html" class="wikilink1" title="documentation:1.4:exportedvars">exported variables configuration</a>.
</p>
</div>
<!-- SECTION "Configuration" [322-1095] -->
<!-- SECTION "Configuration" [322-1161] -->
<h3><a name="apache_configuration" id="apache_configuration">Apache configuration</a></h3>
<div class="level3">
@ -102,7 +107,7 @@ SSLVerifyClient optional_no_ca
</pre>
</div>
<!-- SECTION "Apache configuration" [1096-1480] -->
<!-- SECTION "Apache configuration" [1162-1546] -->
<h3><a name="tests" id="tests">Tests</a></h3>
<div class="level3">
@ -120,4 +125,4 @@ To test this, you can build your own WebID certificate using one of :
</ul>
</div>
<!-- SECTION "Tests" [1481-] --></div><!-- closes <div class="dokuwiki export">-->
<!-- SECTION "Tests" [1547-] --></div><!-- closes <div class="dokuwiki export">-->

13
doc/pages/documentation/1.4/exportedvars.html
View File

@ -59,11 +59,20 @@ Examples for <a href="../../documentation/1.4/authldap.html" class="wikilink1" t
<p>
You can define exported variables for each module in the module configuration itself. Variables defined in the main <code>Exported variables</code> will be used for each backend. Variables defined in the exported variables node of the module will be used only for that module.
</p>
<p>
<p><div class="notetip">You can define environment variables in <code>Exported variables</code>, this allows to populate user session with some environment values. Environment variables will not be queried in users database.
</div></p>
</p>
<p>
<a href="/_detail/documentation/exportedvars.png?id=documentation%3A1.4%3Aexportedvars" class="media" title="documentation:exportedvars.png"><img src="../../../media/documentation/exportedvars.png" class="mediacenter" title="Exported variables in the Manager" alt="Exported variables in the Manager" width="500" /></a>
</p>
</div>
<!-- SECTION "Presentation" [35-771] -->
<!-- SECTION "Presentation" [35-1250] -->
<h2><a name="extend_variables_using_macros_and_groups" id="extend_variables_using_macros_and_groups">Extend variables using macros and groups</a></h2>
<div class="level2">
<div class="plugin_include_content" id="plugin_include__documentation:1.4:performances">
@ -118,4 +127,4 @@ Besides, macros and groups are computed in alphanumeric order, that is, in the o
<div class="level2">
</div>
<!-- SECTION "Extend variables using macros and groups" [772-] --></div><!-- closes <div class="dokuwiki export">-->
<!-- SECTION "Extend variables using macros and groups" [1251-] --></div><!-- closes <div class="dokuwiki export">-->

4
doc/pages/documentation/1.4/start.html
View File

@ -22,11 +22,11 @@
<h1><a name="documentation_for_lemonldapng_13" id="documentation_for_lemonldapng_13">Documentation for LemonLDAP::NG 1.3</a></h1>
<h1><a name="documentation_for_lemonldapng_14" id="documentation_for_lemonldapng_14">Documentation for LemonLDAP::NG 1.4</a></h1>
<div class="level1">
</div>
<!-- SECTION "Documentation for LemonLDAP::NG 1.3" [1-51] -->
<!-- SECTION "Documentation for LemonLDAP::NG 1.4" [1-51] -->
<h2><a name="installation" id="installation">Installation</a></h2>
<div class="level2">