Documentation update

This commit is contained in:
Clément Oudot 2014-01-23 16:39:56 +00:00
parent 4adba0b982
commit fd51bf5e10
2 changed files with 50 additions and 11 deletions

View File

@ -246,8 +246,47 @@ To see available actions, do:
/usr/share/lemonldap-ng/bin/lemonldap-ng-cli help
</pre>
<p>
By default, when you change a value, it will be written to configuration backend but:
</p>
<ul>
<li class="level1"><div class="li"> Configuration cache is not updated</div>
</li>
<li class="level1"><div class="li"> Configuration number is not incremented</div>
</li>
</ul>
<p>
This allows to modify configuration without impacting running users.
</p>
<p>
You can force an update of the cache with:
</p>
<pre class="code">
/usr/share/lemonldap-ng/bin/lemonldap-ng-cli update-cache
</pre>
<p>
And you can save current configuration into a new one:
</p>
<pre class="code">
/usr/share/lemonldap-ng/bin/lemonldap-ng-cli increment
</pre>
<p>
To get information abour current configuration:
</p>
<pre class="code">
/usr/share/lemonldap-ng/bin/lemonldap-ng-cli info
</pre>
</div>
<!-- SECTION "Command Line Interface (CLI)" [4873-5421] -->
<!-- SECTION "Command Line Interface (CLI)" [4873-6018] -->
<h2><a name="apache" id="apache">Apache</a></h2>
<div class="level2">
@ -280,7 +319,7 @@ These files must be included in Apache configuration, either with <code>Include<
</p>
</div>
<!-- SECTION "Apache" [5422-6181] -->
<!-- SECTION "Apache" [6019-6778] -->
<h3><a name="portal" id="portal">Portal</a></h3>
<div class="level3">
@ -379,7 +418,7 @@ In Portal virtual host, you will find several configuration parts:
&lt;/Perl&gt;</pre>
</div>
<!-- SECTION "Portal" [6182-8615] -->
<!-- SECTION "Portal" [6779-9212] -->
<h3><a name="manager1" id="manager1">Manager</a></h3>
<div class="level3">
@ -409,7 +448,7 @@ Manager virtual host is used to serve configuration interface and local document
&lt;/<span class="kw3">Directory</span>&gt;</pre>
</div>
<!-- SECTION "Manager" [8616-9300] -->
<!-- SECTION "Manager" [9213-9897] -->
<h3><a name="handler" id="handler">Handler</a></h3>
<div class="level3">
<ul>
@ -464,7 +503,7 @@ Then, to protect a standard virutal host, the only configuration line to add is:
<pre class="code file apache">PerlHeaderParserHandler My::Package</pre>
</div>
<!-- SECTION "Handler" [9301-10571] -->
<!-- SECTION "Handler" [9898-11168] -->
<h2><a name="configuration_reload" id="configuration_reload">Configuration reload</a></h2>
<div class="level2">
@ -508,7 +547,7 @@ The <code>reload</code> target is managed in Apache configuration, inside a virt
</p>
</div>
<!-- SECTION "Configuration reload" [10572-11928] -->
<!-- SECTION "Configuration reload" [11169-12525] -->
<h2><a name="local_file" id="local_file">Local file</a></h2>
<div class="level2">
@ -548,7 +587,7 @@ For example, to override configured skin for portal:
</p>
</div>
<!-- SECTION "Local file" [11929-12786] -->
<!-- SECTION "Local file" [12526-13383] -->
<h2><a name="script_files" id="script_files">Script files</a></h2>
<div class="level2">
@ -563,7 +602,7 @@ LemonLDAP::NG allows to override any configuration parameter directly in script
</p>
</div>
<!-- SECTION "Script files" [12787-13175] -->
<!-- SECTION "Script files" [13384-13772] -->
<h3><a name="portal1" id="portal1">Portal</a></h3>
<div class="level3">
@ -578,7 +617,7 @@ For example, in portal/index.pl:
<span class="br0">&#41;</span><span class="sy0">;</span></pre>
</div>
<!-- SECTION "Portal" [13176-13346] -->
<!-- SECTION "Portal" [13773-13943] -->
<h3><a name="handler1" id="handler1">Handler</a></h3>
<div class="level3">
@ -593,4 +632,4 @@ For example, in handler/MyHandler.pm:
<span class="br0">&#41;</span><span class="sy0">;</span></pre>
</div>
<!-- SECTION "Handler" [13347-] --></div><!-- closes <div class="dokuwiki export">-->
<!-- SECTION "Handler" [13944-] --></div><!-- closes <div class="dokuwiki export">-->

View File

@ -293,6 +293,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=3126" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3126" rel="nofollow">Rev 3126 -- Remove unused and non-free image</a> by guimard (2014/01/22 06:45)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3125" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3125" rel="nofollow">Rev 3125 -- Bump Standards-Version to 3.9.5</a> by guimard (2014/01/22 06:44)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3124" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3124" rel="nofollow">Rev 3124 -- Display an error if the action is unknown (#LEMONLDAP-649)</a> by clement_oudot (2014/01/21 17:13)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3123" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3123" rel="nofollow">Rev 3123 -- Remove workaround since feature is no more used in lemonldap-ng-cli ...</a> by clement_oudot (2014/01/21 16: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=3122" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3122" rel="nofollow">Rev 3122 -- backport r3116 to 1.3 branch (#LEMONLDAP-665)</a> by clement_oudot (2014/01/21 16:21)</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=3137" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3137" rel="nofollow">Rev 3137 -- Prepare 1.3.2 release (packaging)</a> by clement_oudot (2014/01/23 17:22)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3136" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3136" rel="nofollow">Rev 3136 -- Prepare 1.3.2 release</a> by clement_oudot (2014/01/23 17:21)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3135" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3135" rel="nofollow">Rev 3135 -- Make lemonldap-ng-cli work on RHEL systems (#LEMONLDAP-649)</a> by clement_oudot (2014/01/23 16:59)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3134" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3134" rel="nofollow">Rev 3134 -- Generic method to edit Hash, and fix increment bug due ...</a> by clement_oudot (2014/01/23 16:00)</div></li><li><div class="li"><a href="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3133" class="urlextern" title="http://websvn.ow2.org/revision.php?repname=lemonldap&amp;path=%2F&amp;isdir=1&amp;rev=3133" rel="nofollow">Rev 3133 -- Manage configuration number increment (#LEMONLDAP-649)</a> by clement_oudot (2014/01/23 15:05)</div></li></ul>
</div>
<!-- SECTION "SVN activity" [3457-] --></div><!-- closes <div class="dokuwiki export">-->