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

Update documentation

Browse Source
This commit is contained in:
Xavier Guimard 2013-10-22 12:14:44 +00:00
parent fdb545ca69
commit 625ae5ece0
7 changed files with 120 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/index/alphabetical.html
View File

File diff suppressed because one or more lines are too long

33
doc/pages/documentation/1.3/applications/sympa.html
View File

@ -44,7 +44,7 @@
There are two ways to configure <acronym title="Single Sign On">SSO</acronym> with Sympa:
</p>
<ul>
<li class="level1"><div class="li"> <strong>Auto login</strong>: a special <acronym title="LemonLDAP::NG">LL::NG</acronym> Handler will generate Sympa cookie</div>
<li class="level1"><div class="li"> <strong>Auto login</strong>: a special <acronym title="LemonLDAP::NG">LL::NG</acronym> Handler will generate Sympa cookie (for Sympa 5 only !)</div>
</li>
<li class="level1"><div class="li"> <strong>Magic authentication</strong>: a special <acronym title="Single Sign On">SSO</acronym> <acronym title="Uniform Resource Locator">URL</acronym> is protected by <acronym title="LemonLDAP::NG">LL::NG</acronym>, Sympa will display a button for users who wants to use this feature.</div>
</li>
@ -56,9 +56,9 @@ There are two ways to configure <acronym title="Single Sign On">SSO</acronym> wi
How to choose? Here are some advices:
</p>
<ul>
<li class="level1"><div class="li"> <strong>Auto login</strong> is very secure, as Sympa cookie is only exchanged between <acronym title="LemonLDAP::NG">LL::NG</acronym> Handler and Sympa (user cannot see it)</div>
<li class="level1"><div class="li"> <strong>Auto login</strong> is very secure for Sympa 5, as Sympa cookie is only exchanged between <acronym title="LemonLDAP::NG">LL::NG</acronym> Handler and Sympa (user cannot see it)</div>
</li>
<li class="level1"><div class="li"> <strong>Magic authentication</strong> allows to mix standard Sympa authentication and <acronym title="Single Sign On">SSO</acronym> </div>
<li class="level1"><div class="li"> <strong>Magic authentication</strong> allows to mix standard Sympa authentication and <acronym title="Single Sign On">SSO</acronym></div>
</li>
</ul>
@ -68,7 +68,7 @@ How to choose? Here are some advices:
</p>
</div>
<!-- SECTION "Presentation" [59-668] -->
<!-- SECTION "Presentation" [59-700] -->
<h2><a name="configuration" id="configuration">Configuration</a></h2>
<div class="level2">
@ -78,7 +78,7 @@ Choose one of the following method:
</p>
</div>
<!-- SECTION "Configuration" [669-732] -->
<!-- SECTION "Configuration" [701-764] -->
<h3><a name="auto_login" id="auto_login">Auto login</a></h3>
<div class="level3">
@ -133,7 +133,7 @@ Go in Manager, <code>Default parameters</code> » <code>Advanced parameters</cod
</ul>
</div>
<!-- SECTION "Auto login" [733-1691] -->
<!-- SECTION "Auto login" [765-1723] -->
<h3><a name="magic_authentication" id="magic_authentication">Magic authentication</a></h3>
<div class="level3">
@ -157,7 +157,7 @@ And fill it:
</p>
<pre class="file">
generic_sso
service_name LemonLDAP::NG
service_name Centralized auth service
service_id lemonldapng
email_http_header HTTP_MAIL
netid_http_header HTTP_AUTH_USER
@ -165,6 +165,21 @@ generic_sso
logout_url http://sympa.example.com/wws/logout
</pre>
<p>
<p><div class="notetip">
You can also disable internal Sympa authentication to keep only LemonLDAP::NG by removing user_table paragraph
</p>
<p>
Note that if you use FastCGI, you must restart Apache to enable changes.
</div></p>
</p>
<p>
You can also use &lt;portal&gt;?logout=1 as logout_url to remove LemonLDAP::NG session when “disconnect” is chosen.
</p>
</div>
<h4><a name="sympa_virtual_host_in_apache1" id="sympa_virtual_host_in_apache1">Sympa virtual host in Apache</a></h4>
@ -186,7 +201,7 @@ Configure Sympa virtual host like other <a href="../../../documentation/1.3/conf
&lt;/<span class="kw3">VirtualHost</span>&gt;</pre>
<p>
<p><div class="notetip">The location <acronym title="Uniform Resource Locator">URL</acronym> is based on the <code>service_id</code> defined in Sympa apache configuration.
<p><div class="notetip">The location <acronym title="Uniform Resource Locator">URL</acronym> end is based on the <code>service_id</code> defined in Sympa apache configuration.
</div></p>
</p>
@ -211,4 +226,4 @@ Configure the <a href="../../../documentation/1.3/writingrulesand_headers.html#r
</ul>
</div>
<!-- SECTION "Magic authentication" [1692-] --></div><!-- closes <div class="dokuwiki export">-->
<!-- SECTION "Magic authentication" [1724-] --></div><!-- closes <div class="dokuwiki export">-->

12
doc/pages/documentation/1.3/authwebid.html
View File

@ -109,11 +109,15 @@ SSLVerifyClient optional_no_ca
<p>
To test this, you can build your own WebID certificate using one of :
* <a href="https://metacpan.org/module/Web::ID::Certificate::Generator" class="urlextern" title="https://metacpan.org/module/Web::ID::Certificate::Generator" rel="nofollow">Web::ID::Certificate::Generator</a>
* <a href="https://my-profile.eu/" class="urlextern" title="https://my-profile.eu/" rel="nofollow">my-profile.eu</a>
* <a href="https://gist.github.com/njh/2432427" class="urlextern" title="https://gist.github.com/njh/2432427" rel="nofollow">gen-webid-cert.sh</a>
</p>
<ul>
<li class="level1"><div class="li"> <a href="https://metacpan.org/module/Web::ID::Certificate::Generator" class="urlextern" title="https://metacpan.org/module/Web::ID::Certificate::Generator" rel="nofollow">Web::ID::Certificate::Generator</a></div>
</li>
<li class="level1"><div class="li"> <a href="https://my-profile.eu/" class="urlextern" title="https://my-profile.eu/" rel="nofollow">my-profile.eu</a></div>
</li>
<li class="level1"><div class="li"> <a href="https://gist.github.com/njh/2432427" class="urlextern" title="https://gist.github.com/njh/2432427" rel="nofollow">gen-webid-cert.sh</a></div>
</li>
</ul>
</div>
<!-- SECTION "Tests" [1481-] --></div><!-- closes <div class="dokuwiki export">-->

62
doc/pages/documentation/1.3/fastcgi.html Normal file
View File

@ -0,0 +1,62 @@
<!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="fast_cgi_support" id="fast_cgi_support">Fast CGI support</a></h1>
<div class="level1">
<p>
<acronym title="LemonLDAP::NG">LL::NG</acronym> CGIs <em>(Portal, Manager,…)</em> can be used under a <a href="http://en.wikipedia.org/wiki/FastCGI" class="urlextern" title="http://en.wikipedia.org/wiki/FastCGI" rel="nofollow">Fast CGI system</a> very easily. You just have to load <acronym title="LemonLDAP::NG">LL::NG</acronym> fast <acronym title="Common Gateway Interface">CGI</acronym> support and write a loop in the <acronym title="Common Gateway Interface">CGI</acronym>. Example with the portal:
<pre class="code perl"><span class="co1">#!/usr/bin/perl</span>
<b>use Lemonldap::NG::Common::CGI qw(fastcgi);</b>
<span class="me2">use Lemonldap::NG::Portal::SharedConf;</span>
<span class="re0"># ...</span>
<b><span style="color:#500;">LMAUTH:</span> while ( my $portal = Lemonldap::NG::Portal::SharedConf->new({}) ) </b>{
<span class="re0"># ...</span>
}
</pre>
</p>
<p>
Key steps :
</p>
<ul>
<li class="level1"><div class="li"> Load <strong>“Lemonldap::NG::Common::<acronym title="Common Gateway Interface">CGI</acronym> qw(fastcgi)“</strong> before any other <acronym title="LemonLDAP::NG">LL::NG</acronym> library</div>
</li>
<li class="level1"><div class="li"> insert a loop around the <acronym title="HyperText Markup Language">HTML</acronym> printing, starting with the object creation <em>(→new)</em></div>
</li>
<li class="level1"><div class="li"> insert a label <strong>“LMAUTH”</strong> ahead of the loop</div>
</li>
</ul>
<p>
An example is given under the source tree : lemonldap-ng-portal/example/index.fcgi
</p>
</div>
</div><!-- closes <div class="dokuwiki export">-->

22
doc/pages/documentation/1.3/performances.html
View File

@ -129,8 +129,22 @@ The portal is the biggest component of Lemonldap::NG. It is recommended to use M
PerlResponseHandler ModPerl::Registry
&lt;/<span class="kw3">Files</span>&gt;</pre>
<p>
You can also use a Fast <acronym title="Common Gateway Interface">CGI</acronym> server using index.fcgi given in portal examples.
</p>
</div>
<!-- SECTION "General performances" [2411-2754] -->
<!-- SECTION "General performances" [2411-2833] -->
<h3><a name="configuration_access" id="configuration_access">Configuration access</a></h3>
<div class="level3">
<p>
If you set <code>useLocalConf</code> to 1 in lemonldap-ng.ini (section [Portal]), the portal will use only a cached configuration. To refresh it, you have to set an handler on the same server to use the refresh mechanism or to restart the server after each configuration change.
</p>
</div>
<!-- SECTION "Configuration access" [2834-3136] -->
<h3><a name="starting_performances" id="starting_performances">Starting performances</a></h3>
<div class="level3">
@ -150,7 +164,7 @@ To make the portal start faster when the server is relaunched, add those lines i
&lt;/Perl&gt;</pre>
</div>
<!-- SECTION "Starting performances" [2755-3330] -->
<!-- SECTION "Starting performances" [3137-3712] -->
<h3><a name="apachesession_performances" id="apachesession_performances">Apache::Session performances</a></h3>
<div class="level3">
@ -222,7 +236,7 @@ Note that Apache::Session::Browseable::MySQL doesn&#039;t use MySQL locks.
</p>
</div>
<!-- SECTION "Apache::Session performances" [3331-5600] -->
<!-- SECTION "Apache::Session performances" [3713-5982] -->
<h3><a name="ldap_performances" id="ldap_performances">LDAP performances</a></h3>
<div class="level3">
@ -272,4 +286,4 @@ ldapgroups -&gt; memberOf
</p>
</div>
<!-- SECTION "LDAP performances" [5601-] --></div><!-- closes <div class="dokuwiki export">-->
<!-- SECTION "LDAP performances" [5983-] --></div><!-- closes <div class="dokuwiki export">-->

10
doc/pages/documentation/1.3/start.html
View File

@ -339,7 +339,7 @@ Sessions are stored using <a href="http://search.cpan.org/perldoc?Apache::Sessio
<p>
<div style="width:100px;height:270px;float:left;">
<div style="width:100px;height:290px;float:left;">
<a href="/_detail/icons/neotux.png?id=documentation%3A1.3%3Astart" class="media" title="icons:neotux.png"><img src="../../../media/icons/neotux.png" class="media" alt="" /></a>
</div>
@ -371,12 +371,14 @@ Sessions are stored using <a href="http://search.cpan.org/perldoc?Apache::Sessio
</li>
<li class="level1"><div class="li"> <a href="../../documentation/1.3/handlerauthbasic.html" class="wikilink1" title="documentation:1.3:handlerauthbasic">AuthBasic Handler</a></div>
</li>
<li class="level1"><div class="li"> <a href="../../documentation/1.3/fastcgi.html" class="wikilink1" title="documentation:1.3:fastcgi">Fast CGI support</a></div>
</li>
<li class="level1"><div class="li"> <a href="../../documentation/1.3/parameterlist.html" class="wikilink1" title="documentation:1.3:parameterlist">See full parameters list</a></div>
</li>
</ul>
</div>
<!-- SECTION "Advanced features" [6262-7031] -->
<!-- SECTION "Advanced features" [6262-7064] -->
<h2><a name="mini_howtos" id="mini_howtos">Mini howtos</a></h2>
<div class="level2">
@ -405,7 +407,7 @@ Sessions are stored using <a href="http://search.cpan.org/perldoc?Apache::Sessio
</ul>
</div>
<!-- SECTION "Mini howtos" [7032-7662] -->
<!-- SECTION "Mini howtos" [7065-7695] -->
<h2><a name="exploitation" id="exploitation">Exploitation</a></h2>
<div class="level2">
@ -434,4 +436,4 @@ Sessions are stored using <a href="http://search.cpan.org/perldoc?Apache::Sessio
</ul>
</div>
<!-- SECTION "Exploitation" [7663-] --></div><!-- closes <div class="dokuwiki export">-->
<!-- SECTION "Exploitation" [7696-] --></div><!-- closes <div class="dokuwiki export">-->

2
doc/pages/start.html
View File

@ -285,6 +285,6 @@ LemonLDAP::NG is the first <acronym title="Single Sign On">SSO</acronym> softwar
<a href="/_detail/icons/clock.png?id=start" class="media" title="icons:clock.png"><img src="../media/icons/clock.png" class="media" alt="" /></a>
</div>
</p>
<ul class="rss"><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=2974" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=2974" rel="nofollow">Rev 2974 -- UserDBWebID seems to be finished</a> by guimard (2013/10/13 14:33)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=2973" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=2973" rel="nofollow">Rev 2973 -- Remove debug line</a> by guimard (2013/10/13 14:32)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=2972" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=2972" rel="nofollow">Rev 2972 -- AuthWebID seems to be ready...</a> by guimard (2013/10/13 14:15)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=2971" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=2971" rel="nofollow">Rev 2971 -- Use user* methods instead of lmLog for user actions (can ...</a> by guimard (2013/10/13 14:15)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=2970" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=2970" rel="nofollow">Rev 2970 -- Split tests: certificate can exist without having wanted attribute</a> by guimard (2013/10/13 14:13)</div></li></ul>
<ul class="rss"><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3002" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3002" rel="nofollow">Rev 3002 -- Add &quot;useLocalConf&quot; parameter for the portal to increase performances ...</a> by guimard (2013/10/22 14:02)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3001" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3001" rel="nofollow">Rev 3001 -- Replace &quot;fast&quot; keyword by &quot;fastcgi&quot;</a> by guimard (2013/10/22 06:39)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3000" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3000" rel="nofollow">Rev 3000 -- FastCGI portal</a> by guimard (2013/10/21 23:24)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=2999" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=2999" rel="nofollow">Rev 2999 -- Missing constants in @EXPORT</a> by guimard (2013/10/21 20:55)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=2998" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=2998" rel="nofollow">Rev 2998 -- Add optimization proposed by Jean-Charles + stupid bug</a> by guimard (2013/10/20 07:32)</div></li></ul>
</div>
<!-- SECTION "SVN activity" [3372-] --></div><!-- closes <div class="dokuwiki export">-->