Commit d2c015c5 authored by Yadd's avatar Yadd
Browse files

Documentation update

parent 4634d58f
......@@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
"HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation: 1-Overview-fr.html</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
......
......@@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
"HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation: 1-Overview.html</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
......
......@@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
"HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation: 2-FAQ-fr.html</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
......
......@@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
"HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation: 2-FAQ.html</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
......
......@@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
"HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation: 3-Table-of-contents-fr.html</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
......@@ -121,6 +121,9 @@
<li><a href="#HErreurs">Erreurs</a></li>
<li><a href="#HFormations">Formations</a></li>
<li><a href="#HRapportsdetestsduCPAN">Rapports de tests du
CPAN</a></li>
</ul>
</li>
</ul><strong class="strong">Documentation applicable pour LemonLDAP::NG
......@@ -315,6 +318,10 @@
<li><span class="wikilink"><a href=
"4.9-Reset-password-by-mail.html">Envoi d'un nouveau mot de passe par
mail</a></span> (en)</li>
<li><span class="wikilink"><a href=
"/xwiki/bin/view/NG/CustomFuctions">Cr&eacute;er et utiliser des
fonctions personnalis&eacute;es</a></span> (en)</li>
</ul>
<h3 class="heading-1-1"><span id="HProtectiondesapplications">Protection
......@@ -536,6 +543,27 @@
"http://linagora.org/contrib/annuaires/formations/websso_lemonldap_ng">Le
WebSSO LemonLDAP::NG (LINAGORA)</a></span> (fr)</li>
</ul>
<h4 class="heading-1-1-1"><span id="HRapportsdetestsduCPAN">Rapports de
tests du CPAN</span></h4>
<ul class="star">
<li><span class="wikiexternallink"><a href=
"http://www.cpantesters.org/distro/L/Lemonldap-NG-Common.html">LemonLDAP::NG
Common</a></span></li>
<li><span class="wikiexternallink"><a href=
"http://www.cpantesters.org/distro/L/Lemonldap-NG-Handler.html">LemonLDAP::NG
Handler</a></span></li>
<li><span class="wikiexternallink"><a href=
"http://www.cpantesters.org/distro/L/Lemonldap-NG-Portal.html">LemonLDAP::NG
Portal</a></span></li>
<li><span class="wikiexternallink"><a href=
"http://www.cpantesters.org/distro/L/Lemonldap-NG-Manager.html">LemonLDAP::NG
Manager</a></span></li>
</ul>
</div>
<p class="footer"><a href="index.html">Index</a></p>
......
......@@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
"HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation: 3-Table-of-contents.html</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
......@@ -116,6 +116,8 @@
<li><a href="#HErrors">Errors</a></li>
<li><a href="#HTraining">Training</a></li>
<li><a href="#HCPANTesterReports">CPAN Tester Reports</a></li>
</ul>
</li>
</ul><strong class="strong">Documentation applicable for LemonLDAP::NG
......@@ -306,6 +308,10 @@
<li><span class="wikilink"><a href=
"4.9-Reset-password-by-mail.html">Reset password by mail</a></span>
(en)</li>
<li><span class="wikilink"><a href=
"/xwiki/bin/view/NG/CustomFuctions">Create and use custom
functions</a></span> (en)</li>
</ul>
<h3 class="heading-1-1"><span id="HApplicationprotection">Application
......@@ -519,6 +525,27 @@
"http://linagora.org/contrib/annuaires/formations/websso_lemonldap_ng">The
WebSSO LemonLDAP::NG (LINAGORA)</a></span> (fr)</li>
</ul>
<h4 class="heading-1-1-1"><span id="HCPANTesterReports">CPAN Tester
Reports</span></h4>
<ul class="star">
<li><span class="wikiexternallink"><a href=
"http://www.cpantesters.org/distro/L/Lemonldap-NG-Common.html">LemonLDAP::NG
Common</a></span></li>
<li><span class="wikiexternallink"><a href=
"http://www.cpantesters.org/distro/L/Lemonldap-NG-Handler.html">LemonLDAP::NG
Handler</a></span></li>
<li><span class="wikiexternallink"><a href=
"http://www.cpantesters.org/distro/L/Lemonldap-NG-Portal.html">LemonLDAP::NG
Portal</a></span></li>
<li><span class="wikiexternallink"><a href=
"http://www.cpantesters.org/distro/L/Lemonldap-NG-Manager.html">LemonLDAP::NG
Manager</a></span></li>
</ul>
</div>
<p class="footer"><a href="index.html">Index</a></p>
......
......@@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
"HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation: 3.1-Install-prerequesites.html</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
......
......@@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
"HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation: 3.2-Install-from-tarball.html</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
......@@ -208,6 +208,9 @@ $ sudo make install PARAM=VALUE PARAM=VALUE ...
<li>PREFIX: installation directory (default: /usr/local)</li>
<li>STORAGECONFFILE: location of default storage configuration file
(default: /usr/local/lemonldap-ng/etc/storage.conf)</li>
<li>CRONDIR: Cronfile directory (default:
$PREFIX/etc/lemonldap-ng/cron.d)</li>
......
......@@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
"HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation:
3.3-Install-from-debian-packages.html</title>
......
......@@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
"HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation:
3.3-Install-from-redhat-packages.html</title>
......
......@@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
"HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation:
3.3-Install-from-suse-packages.html</title>
......
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
<title>Lemonldap::NG documentation:
3.4-Install-of-MySQL-storage.html</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
<style type="text/css">
/*<![CDATA[*/
body{
background: #ddd;
font-family: sans-serif;
font-size: 11pt;
padding: 0 50px;
}
div.main-content{
padding: 10px;
background: #fff;
border: 2px #ccc solid;
}
a{
text-decoration: none;
}
p.footer{
text-align: center;
margin: 5px 0 0 0;
}
.heading-1{
text-align: center;
color: orange;
font-variant: small-caps;
font-size: 20pt;
}
.heading-1-1{
color: orange;
font-size: 14pt;
border-bottom: 2px #ccc solid;
}
pre{
background: #eee;
border: 2px #ccc solid;
padding: 5px;
border-left: 10px #ccc solid;
}
ul.star li{
list-style-type: square;
}
/*]]>*/
</style>
</head>
<body>
<div class="main-content">
<h2 class="heading-1"><span id="HUseofMySQLforconfigurationstorage">Use of
MySQL for configuration storage</span></h2>
<p class="paragraph"></p>
<ul>
<li>
<a href="#HMySQLconfiguration">MySQL configuration</a>
<ul>
<li><a href="#HDatabasecreation">Database creation</a></li>
<li><a href="#HConfigurationtable">Configuration table</a></li>
</ul>
</li>
<li>
<a href="#HLemonLDAP3A3ANGconfiguration">LemonLDAP::NG
configuration</a>
<ul>
<li><a href="#HDefaultconfiguration">Default configuration</a></li>
<li><a href=
"#HOverrideconfigStorageforLemonLDAP3A3ANGmodules">Override
configStorage for LemonLDAP::NG modules</a></li>
</ul>
</li>
</ul>
<h3 class="heading-1-1"><span id="HMySQLconfiguration">MySQL
configuration</span></h3>
<p class="paragraph"></p><strong class="strong">Remark</strong>: we advice
to create a specific user/password in MySQL for LemonLDAP::NG, with rights
on ist database.
<h4 class="heading-1-1-1"><span id="HDatabasecreation">Database
creation</span></h4><br />
<br />
For example, create the database "lemonldap-ng" :<br />
<br />
<div class="code">
<pre>
# mysqladmin create lemonldap-ng
</pre>
</div>
<h4 class="heading-1-1-1"><span id="HConfigurationtable">Configuration
table</span></h4><br />
<br />
To store configuration, use this table creation instruction:<br />
<br />
<div class="code">
<pre>
CREATE TABLE lmConfig (
cfgNum <span class="java-object">int</span> not <span class=
"java-keyword">null</span> primary key,
locationRules text,
exportedHeaders text,
globalStorage text,
globalStorageOptions text,
macros text,
groups text,
portal text,
domain text,
ldapServer text,
ldapPort <span class="java-object">int</span>,
ldapBase text,
securedCookie <span class="java-object">int</span>,
cookieName text,
authentication text,
exportedVars text,
managerDn text,
managerPassword text,
whatToTrace text,
timeout <span class="java-object">int</span>
);
</pre>
</div>
<h3 class="heading-1-1"><span id=
"HLemonLDAP3A3ANGconfiguration">LemonLDAP::NG configuration</span></h3>
<h4 class="heading-1-1-1"><span id="HDefaultconfiguration">Default
configuration</span></h4>
<p class="paragraph"></p>You can set this directly in <strong class=
"strong">storage.conf</strong>:
<p class="paragraph"></p>
<div class="code">
<pre>
type = DBI
dbiChain = DBI:mysql:database=lemonldap-ng;host=1.2.3.4
dbiUser = lemonldap
dbiPassword = password
dbiTable = lmConfig
</pre>
</div>
<h4 class="heading-1-1-1"><span id=
"HOverrideconfigStorageforLemonLDAP3A3ANGmodules">Override configStorage
for LemonLDAP::NG modules</span></h4>
<p class="paragraph"></p>Edit for example <strong class=
"strong">portal/index.pl</strong> or <strong class=
"strong">handler/MyHandler.pm</strong>:
<div class="code">
<pre>
configStorage =&gt; {
type =&gt; <span class="java-quote">"DBI"</span>,
dbiChain =&gt; <span class="java-quote">"dbi:mysql:..."</span>,
dbiUser =&gt; <span class="java-quote">"lemonldap"</span>,
dbiPassword =&gt; <span class="java-quote">"password"</span>,
dbiTable =&gt; <span class="java-quote">"lmConfig"</span>,
},
</pre>
</div>
<p class="paragraph"></p>
</div>
<p class="footer"><a href="index.html">Index</a></p>
</body>
</html>
......@@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
"HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation: 4.1-Configuration-overview.html</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
......
......@@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
"HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation:
4.1-Configuration-parameter-list.html</title>
......@@ -78,6 +78,9 @@
<li><a href="#HSMTP28resetpasswordbymail29">SMTP (reset password by
mail)</a></li>
<li><a href="#HTemplatescustomization">Templates
customization</a></li>
</ul>
</li>
......@@ -86,15 +89,22 @@
configuration (Portal only)</a>
<ul>
<li><a href="#HCommon-1">Common</a></li>
<li><a href="#HLDAP">LDAP</a></li>
<li><a href="#HDBI">DBI</a></li>
<li><a href="#HSSL">SSL</a></li>
<li><a href="#HCAS">CAS</a></li>
<li><a href="#HRemote">Remote</a></li>
<li><a href="#HLibertyAlliance">Liberty Alliance</a></li>
<li><a href="#HLibertyAlliance28willbereplacedbySAMLin09529">Liberty
Alliance (will be replaced by SAML in 0.9.5)</a></li>
<li><a href="#HTwitter">Twitter</a></li>
</ul>
</li>
</ul>
......@@ -128,13 +138,47 @@ keyname =&gt; 'value',
</pre>
</div><br />
<br />
The key name can also be seen when you access directly to the
configuration backend (for example with an LDAP browser if you choose the
<span class="wikilink"><a href="4.3-LDAP-configuration-backend.html">LDAP
configuration backend</a></span>).<br />
<strong class="strong">WARNING</strong>: if you modify these files,
updates will potentially erase your local modifications. You can choose to
copy the provided .pl file and override configuration in the new file, not
known from package, so not erased on updates.<br />
<br />
For example to fork the portal page:
<div class="code">
<pre>
# cp portal/index.pl portal/indexcustom.pl
</pre>
</div><br />
<br />
And adapt apache configuration to server your file instead of default
file:
<div class="code">
<pre>
# vi /etc/lemonldap-ng/apache2.conf
</pre>
</div><br />
<br />
When a key name contains one or more /, it means that it's multi-level
hash map. For example level1Key / level2Key will be used as:
<div class="code">
<pre>
&lt;VirtualHost *&gt;
ServerName auth.example.com<br /><br /> DocumentRoot /usr/local/lemonldap-ng/htdocs/portal/
DirectoryIndex indexcustom.pl<br /><br /> # Other configuration parameters
&lt;/VirtualHost&gt;
</pre>
</div>
<p class="paragraph"></p>The key name can also be seen when you access
directly to the configuration backend (for example with an LDAP browser if
you choose the <span class="wikilink"><a href=
"4.3-LDAP-configuration-backend.html">LDAP configuration
backend</a></span>).
<p class="paragraph"></p>When a key name contains one or more /, it means
that it's multi-level hash map. For example level1Key / level2Key will be
used as:
<div class="code">
<pre>
......@@ -348,6 +392,26 @@ level1Key =&gt; { level2Key =&gt; 'value' },
<td>&nbsp;</td>
</tr>
<tr class="table-even">
<td>Issuer backend</td>
<td>issuerDB</td>
<td>0.9.5</td>
<td>No</td>
<td>X</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
</table>
<h4 class="heading-1-1-1"><span id="HCommon">Common</span></h4><br />
......@@ -555,6 +619,26 @@ level1Key =&gt; { level2Key =&gt; 'value' },
</tr>
<tr class="table-even">
<td>Cookie expiration</td>
<td>cookieExpiration</td>
<td>0.9.5</td>
<td>No</td>
<td>X</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr class="table-odd">
<td>Attributes from user backend</td>
<td>exportedVars</td>
......@@ -574,7 +658,7 @@ level1Key =&gt; { level2Key =&gt; 'value' },
<td>&nbsp;</td>
</tr>
<tr class="table-odd">
<tr class="table-even">
<td>Local groups</td>
<td>groups</td>
......@@ -594,7 +678,7 @@ level1Key =&gt; { level2Key =&gt; 'value' },
<td>&nbsp;</td>
</tr>
<tr class="table-even">
<tr class="table-odd">
<td>Macros</td>
<td>macros</td>
......@@ -614,7 +698,7 @@ level1Key =&gt; { level2Key =&gt; 'value' },
<td>&nbsp;</td>
</tr>
<tr class="table-odd">
<tr class="table-even">
<td>Session lifetime for cronjob</td>
<td>timeout</td>
......@@ -634,7 +718,7 @@ level1Key =&gt; { level2Key =&gt; 'value' },
<td>&nbsp;</td>
</tr>
<tr class="table-even">
<tr class="table-odd">
<td>Syslog facility</td>
<td>syslog</td>
......@@ -654,7 +738,7 @@ level1Key =&gt; { level2Key =&gt; 'value' },
<td>&nbsp;</td>
</tr>
<tr class="table-odd">
<tr class="table-even">
<td>SOAP activation</td>
<td>Soap</td>
......@@ -674,7 +758,7 @@ level1Key =&gt; { level2Key =&gt; 'value' },
<td>&nbsp;</td>
</tr>
<tr class="table-even">
<tr class="table-odd">
<td>Attributes exported in SOAP</td>