Update documentation (#26)

2014-06-02 16:28:02 +00:00 · 2014-06-02 16:28:02 +00:00 · aa40798d0c
commit aa40798d0c
parent 1dd340faea
6 changed files with 195 additions and 33 deletions
--- a/doc/index/alphabetical.html
+++ b/doc/index/alphabetical.html
--- 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 <acronym title="
 <div class="level2">
 <table class="inline">
 	<tr class="row0 roweven">
-		<th class="col0 centeralign">  <acronym title="Hyper Text Transfer Protocol">HTTP</acronym> Auth-Basic  </th><th class="col1 centeralign">  Tomcat  </th>
+		<th class="col0 centeralign">  <acronym title="Hyper Text Transfer Protocol">HTTP</acronym> Auth-Basic  </th><th class="col1 centeralign">  Tomcat  </th><th class="col2 centeralign">  Nginx  </th>
 	</tr>
 	<tr class="row1 rowodd">
-		<td class="col0 centeralign">  <a href="../../documentation/1.4/applications/authbasic.html" class="media" title="documentation:1.4:applications:authbasic"><img src="../../../media/applications/http_logo.png" class="media" alt="" /></a>  </td><td class="col1 rightalign">  <a href="../../documentation/1.4/applications/tomcat.html" class="media" title="documentation:1.4:applications:tomcat"><img src="../../../media/applications/tomcat_logo.png" class="media" alt="" /></a> </td>
+		<td class="col0 centeralign">  <a href="../../documentation/1.4/applications/authbasic.html" class="media" title="documentation:1.4:applications:authbasic"><img src="../../../media/applications/http_logo.png" class="media" alt="" /></a>  </td><td class="col1 rightalign">  <a href="../../documentation/1.4/applications/tomcat.html" class="media" title="documentation:1.4:applications:tomcat"><img src="../../../media/applications/tomcat_logo.png" class="media" alt="" /></a> </td><td class="col2 centeralign">  <a href="../../documentation/1.4/applications/nginx.html" class="media" title="documentation:1.4:applications:nginx"><img src="../../../media/applications/nginx_logo.png" class="media" alt="" /></a>  </td>
 	</tr>
 	<tr class="row2 roweven">
-		<th class="col0 centeralign" colspan="2">  Some applications using it  </th>
+		<th class="col0 centeralign" colspan="3">  Some applications using it  </th>
 	</tr>
 	<tr class="row3 rowodd">
 		<td class="col0"> <a href="http://en.wikipedia.org/wiki/Outlook_Web_App" class="urlextern" title="http://en.wikipedia.org/wiki/Outlook_Web_App"  rel="nofollow">Outlook Web App</a> <br/>
 <a href="http://en.wikipedia.org/wiki/IBM_Lotus_iNotes" class="urlextern" title="http://en.wikipedia.org/wiki/IBM_Lotus_iNotes"  rel="nofollow">IBM Lotus iNotes</a> </td><td class="col1 leftalign"> <a href="http://www.lambdaprobe.org" class="urlextern" title="http://www.lambdaprobe.org"  rel="nofollow">Probe</a> <br/>
-<a href="http://fr.lutece.paris.fr" class="urlextern" title="http://fr.lutece.paris.fr"  rel="nofollow">Lutece</a>  </td>
+<a href="http://fr.lutece.paris.fr" class="urlextern" title="http://fr.lutece.paris.fr"  rel="nofollow">Lutece</a>  </td><td class="col2"> </td>
 	</tr>
 </table>

 </div>
-<!-- SECTION "Connectors" [2097-2535] -->
+<!-- SECTION "Connectors" [2097-2609] -->
 <h2><a name="saml_connectors" id="saml_connectors">SAML connectors</a></h2>
 <div class="level2">

@ -166,4 +166,4 @@ Applications listed bellow are known to be easy to integrate in <acronym title="
 </table>

 </div>
-<!-- SECTION "SAML connectors" [2536-] --></div><!-- closes <div class="dokuwiki export">-->
+<!-- SECTION "SAML connectors" [2610-] --></div><!-- closes <div class="dokuwiki export">-->
--- a/doc/pages/documentation/1.4/applications/nginx.html
+++ b/doc/pages/documentation/1.4/applications/nginx.html
@ -0,0 +1,64 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
+ lang="en" dir="ltr">
+
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title></title>
+<!-- metadata -->
+<meta name="generator" content="Offline" />
+<meta name="version" content="Offline 0.1" />
+<!-- style sheet links -->
+<link rel="stylesheet" media="all" type="text/css" href="../../../../css/all.css" />
+<link rel="stylesheet" media="screen" type="text/css" href="../../../../css/screen.css" />
+<link rel="stylesheet" media="print" type="text/css" href="../../../../css/print.css" />
+
+</head>
+<body>
+<div class="dokuwiki export">
+
+
+
+
+<h1><a name="nginx_lua_handler" id="nginx_lua_handler">Nginx LUA Handler</a></h1>
+<div class="level1">
+
+<p>
+
+<p><div class="noteimportant">This Handler is an alternative for the <acronym title="Practical Extraction and Report Language">Perl</acronym> Nginx Handler provided in the LemonLDAP::NG project.
+</div></p>
+</p>
+
+</div>
+<!-- SECTION "Nginx LUA Handler" [1-154] -->
+<h2><a name="presentation" id="presentation">Presentation</a></h2>
+<div class="level2">
+
+<p>
+
+Nginx is a very fast web server. The LUA <acronym title="Application Programming Interface">API</acronym> allows to write some hooks.
+</p>
+
+<p>
+The LUA Handler for LemonLDAP::NG uses <acronym title="Simple Object Access Protocol">SOAP</acronym> to get configuration and sessions.
+</p>
+
+</div>
+<!-- SECTION "Presentation" [155-334] -->
+<h2><a name="installation" id="installation">Installation</a></h2>
+<div class="level2">
+
+<p>
+
+The LUA Handler is available on GitHub: <a href="https://github.com/davidcoutadeur/lemonldap-lua-handler" class="urlextern" title="https://github.com/davidcoutadeur/lemonldap-lua-handler"  rel="nofollow">https://github.com/davidcoutadeur/lemonldap-lua-handler</a>
+</p>
+
+<p>
+See the README.md to know how install and configure it. 
+
+</p>
+
+</div>
+<!-- SECTION "Installation" [335-] --></div><!-- closes <div class="dokuwiki export">-->
--- 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:
 </li>
 <li class="level1"><div class="li"> dark</div>
 </li>
+<li class="level1"><div class="li"> bootstrap</div>
+</li>
 </ul>

 <p>
@ -55,7 +57,7 @@ But you can make your own, see Skin customization below.
 </p>

 </div>
-<!-- SECTION "Skin" [143-289] -->
+<!-- SECTION "Skin" [143-303] -->
 <h3><a name="default_skin" id="default_skin">Default skin</a></h3>
 <div class="level3">

@ -69,7 +71,7 @@ You can change the default skin in Manager: <code>General Parameters</code> &gt;
 </p>

 </div>
-<!-- SECTION "Default skin" [290-480] -->
+<!-- SECTION "Default skin" [304-494] -->
 <h3><a name="skin_rules" id="skin_rules">Skin rules</a></h3>
 <div class="level3">

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

 </div>
-<!-- SECTION "Skin rules" [481-1123] -->
+<!-- SECTION "Skin rules" [495-1137] -->
 <h3><a name="skin_files" id="skin_files">Skin files</a></h3>
 <div class="level3">

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

 </div>
-<!-- SECTION "Skin files" [1124-1458] -->
+<!-- SECTION "Skin files" [1138-1472] -->
 <h3><a name="skin_customization" id="skin_customization">Skin customization</a></h3>
 <div class="level3">

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

 </div>
-<!-- SECTION "Skin customization" [1459-2553] -->
+<!-- SECTION "Skin customization" [1473-2567] -->
 <h3><a name="error_messages" id="error_messages">Error messages</a></h3>
 <div class="level3">

@ -189,7 +191,7 @@ Error messages are defined in source code. If they really do not please you, ove
 <span class="re1">error_0</span> <span class="sy0">=</span><span class="re2"> Big brother is watching you, authenticated user</span></pre>

 </div>
-<!-- SECTION "Error messages" [2554-2891] -->
+<!-- SECTION "Error messages" [2568-2905] -->
 <h3><a name="template_parameters" id="template_parameters">Template parameters</a></h3>
 <div class="level3">

@ -209,14 +211,43 @@ Then you will be able to use it in your template like this:
 <pre class="code file html4strict">Hello <span class="sc2">&lt;TMPL_VAR <span class="kw3">NAME</span><span class="sy0">=</span><span class="st0">&quot;myparam&quot;</span>&gt;</span>!</pre>

 </div>
-<!-- SECTION "Template parameters" [2892-3262] -->
+<!-- SECTION "Template parameters" [2906-3276] -->
+<h2><a name="buttons" id="buttons">Buttons</a></h2>
+<div class="level2">
+
+<p>
+
+This node allows to enable/disable buttons on the login page:
+</p>
+<ul>
+<li class="level1"><div class="li"> <strong>Check last logins</strong>: displays a checkbox on login form, allowing user to check his login history right after opening session</div>
+</li>
+<li class="level1"><div class="li"> <strong>Reset password</strong>: display a link to <a href="../../documentation/1.4/resetpassword.html" class="wikilink1" title="documentation:1.4:resetpassword">reset your password page</a> (for password based authentication backends)</div>
+</li>
+<li class="level1"><div class="li"> <strong>Register</strong>: display a link to <a href="../../documentation/1.4/register.html" class="wikilink1" title="documentation:1.4:register">register page</a> (for password based authentication backends)</div>
+</li>
+</ul>
+
+</div>
+<!-- SECTION "Buttons" [3277-3730] -->
+<h2><a name="password_management" id="password_management">Password management</a></h2>
+<div class="level2">
+<ul>
+<li class="level1"><div class="li"> <strong>Require old password</strong>: used only in the password changing module of the menu, will check the old password before updating it</div>
+</li>
+<li class="level1"><div class="li"> <strong>Hide old password</strong>: used only if the password need to be reset by the user (<acronym title="Lightweight Directory Access Protocol">LDAP</acronym> password policy), will hide the old password input</div>
+</li>
+<li class="level1"><div class="li"> <strong>Send mail on password change</strong>: send a mail if the password is changed from the Menu, or from forced password reset (<acronym title="Lightweight Directory Access Protocol">LDAP</acronym> password policy)</div>
+</li>
+</ul>
+
+</div>
+<!-- SECTION "Password management" [3731-4181] -->
 <h2><a name="other_parameters" id="other_parameters">Other parameters</a></h2>
 <div class="level2">
 <ul>
 <li class="level1"><div class="li"> <strong>Auto complete</strong>: allow the browser to remember the password (for password based authentication backends)</div>
 </li>
-<li class="level1"><div class="li"> <strong>Check last logins</strong>: displays a checkbox on login form, allowing user to check his login history right after opening session</div>
-</li>
 <li class="level1"><div class="li"> <strong>User attribute</strong>: which session attribute will be used to display <code>Connected as</code> in the menu</div>
 </li>
 <li class="level1"><div class="li"> <strong>New window</strong>: open menu links in new window</div>
@ -225,18 +256,6 @@ Then you will be able to use it in your template like this:
 </li>
 <li class="level1"><div class="li"> <strong>Ping interval</strong>: Number of milliseconds between each ping (Ajax request) on the portal menu. Set to 0 to dismiss checks.</div>
 </li>
-<li class="level1"><div class="li"> <strong>Password Management</strong>:</div>
-<ul>
-<li class="level2"><div class="li"> <strong>Reset password</strong>: display a link to <a href="../../documentation/1.4/resetpassword.html" class="wikilink1" title="documentation:1.4:resetpassword">reset a password</a> (for password based authentication backends)</div>
-</li>
-<li class="level2"><div class="li"> <strong>Require old password</strong>: used only in the password changing module of the menu, will check the old password before updating it</div>
-</li>
-<li class="level2"><div class="li"> <strong>Hide old password</strong>: used only if the password need to be reset by the user (<acronym title="Lightweight Directory Access Protocol">LDAP</acronym> password policy), will hide the old password input</div>
-</li>
-<li class="level2"><div class="li"> <strong>Send mail on password change</strong>: send a mail if the password is changed from the Menu, or from forced password reset (<acronym title="Lightweight Directory Access Protocol">LDAP</acronym> password policy)</div>
-</li>
-</ul>
-</li>
 </ul>

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

 </div>
-<!-- SECTION "Other parameters" [3263-] --></div><!-- closes <div class="dokuwiki export">-->
+<!-- SECTION "Other parameters" [4182-] --></div><!-- closes <div class="dokuwiki export">-->
--- a/doc/pages/documentation/1.4/register.html
+++ b/doc/pages/documentation/1.4/register.html
@ -0,0 +1,77 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
+ lang="en" dir="ltr">
+
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title></title>
+<!-- metadata -->
+<meta name="generator" content="Offline" />
+<meta name="version" content="Offline 0.1" />
+<!-- style sheet links -->
+<link rel="stylesheet" media="all" type="text/css" href="../../../css/all.css" />
+<link rel="stylesheet" media="screen" type="text/css" href="../../../css/screen.css" />
+<link rel="stylesheet" media="print" type="text/css" href="../../../css/print.css" />
+
+</head>
+<body>
+<div class="dokuwiki export">
+
+
+
+
+<h1><a name="register_a_new_account" id="register_a_new_account">Register a new account</a></h1>
+<div class="level1">
+
+</div>
+<!-- SECTION "Register a new account" [1-38] -->
+<h2><a name="presentation" id="presentation">Presentation</a></h2>
+<div class="level2">
+
+<p>
+
+This feature is a page that allows a user to create an account. The steps are the following:
+</p>
+<ol>
+<li class="level1"><div class="li"> User click on the button “Create a new account”</div>
+</li>
+<li class="level1"><div class="li"> He enters first name, last name and email</div>
+</li>
+<li class="level1"><div class="li"> He gets a mail with a confirmation link</div>
+</li>
+<li class="level1"><div class="li"> After clicking, his entry is added</div>
+</li>
+<li class="level1"><div class="li"> He gets a mail with his login and his password</div>
+</li>
+</ol>
+
+</div>
+<!-- SECTION "Presentation" [39-390] -->
+<h2><a name="configuration" id="configuration">Configuration</a></h2>
+<div class="level2">
+
+<p>
+
+You can enable the “Create your account” button in <a href="../../documentation/1.4/portalcustom.html" class="wikilink1" title="documentation:1.4:portalcustom">portal customization parameters</a>.
+</p>
+
+<p>
+Then, go in <code>Portal</code> &gt; <code>Advanced parameters</code> &gt; <code>Register new account</code>:
+</p>
+<ul>
+<li class="level1"><div class="li"> <strong>Module</strong>: Choose the backend to use to create the new account.</div>
+</li>
+<li class="level1"><div class="li"> <strong>Page <acronym title="Uniform Resource Locator">URL</acronym></strong>: <acronym title="Uniform Resource Locator">URL</acronym> of register page</div>
+</li>
+<li class="level1"><div class="li"> <strong>Validity time of a register request</strong>: duration in seconds of a new account request. The request will be deleted after this time if user do not click on the link.</div>
+</li>
+<li class="level1"><div class="li"> <strong>Subject for confirmation mail</strong>: Subject of the mail containing the confirmation link</div>
+</li>
+<li class="level1"><div class="li"> <strong>Subject for done mail</strong>: Subject of the mail giving login and password</div>
+</li>
+</ul>
+
+</div>
+<!-- SECTION "Configuration" [391-] --></div><!-- closes <div class="dokuwiki export">-->
--- a/doc/pages/documentation/1.4/start.html
+++ b/doc/pages/documentation/1.4/start.html
@ -342,7 +342,7 @@ Sessions are stored using <a href="http://search.cpan.org/perldoc?Apache::Sessio

 <p>

-<div style="width:100px;height:290px;float:left;">
+<div style="width:100px;height:310px;float:left;">
 <a href="/_detail/icons/neotux.png?id=documentation%3A1.4%3Astart" class="media" title="icons:neotux.png"><img src="../../../media/icons/neotux.png" class="media" alt="" /></a>
 </div>

@ -362,6 +362,8 @@ Sessions are stored using <a href="http://search.cpan.org/perldoc?Apache::Sessio
 </li>
 <li class="level1"><div class="li"> <a href="../../documentation/1.4/resetpassword.html" class="wikilink1" title="documentation:1.4:resetpassword">Reset password by mail (self service)</a></div>
 </li>
+<li class="level1"><div class="li"> <a href="../../documentation/1.4/register.html" class="wikilink1" title="documentation:1.4:register">Create an account (self service)</a></div>
+</li>
 <li class="level1"><div class="li"> <a href="../../documentation/1.4/logoutforward.html" class="wikilink1" title="documentation:1.4:logoutforward">Forward logout to applications</a></div>
 </li>
 <li class="level1"><div class="li"> <a href="../../documentation/1.4/securetoken.html" class="wikilink1" title="documentation:1.4:securetoken">Secure Token Handler</a></div>
@ -381,7 +383,7 @@ Sessions are stored using <a href="http://search.cpan.org/perldoc?Apache::Sessio
 </ul>

 </div>
-<!-- SECTION "Advanced features" [6480-7282] -->
+<!-- SECTION "Advanced features" [6480-7332] -->
 <h2><a name="mini_howtos" id="mini_howtos">Mini howtos</a></h2>
 <div class="level2">

@ -410,7 +412,7 @@ Sessions are stored using <a href="http://search.cpan.org/perldoc?Apache::Sessio
 </ul>

 </div>
-<!-- SECTION "Mini howtos" [7283-7913] -->
+<!-- SECTION "Mini howtos" [7333-7963] -->
 <h2><a name="exploitation" id="exploitation">Exploitation</a></h2>
 <div class="level2">

@ -439,4 +441,4 @@ Sessions are stored using <a href="http://search.cpan.org/perldoc?Apache::Sessio
 </ul>

 </div>
-<!-- SECTION "Exploitation" [7914-] --></div><!-- closes <div class="dokuwiki export">-->
+<!-- SECTION "Exploitation" [7964-] --></div><!-- closes <div class="dokuwiki export">-->