Commit 0cb72f55 authored by Clément OUDOT's avatar Clément OUDOT

Update documentation script to request the new wiki (#192)

parent 7f8e7084
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
<?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 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" />
<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="HInstallationfromthetarball">Installation
from the tarball</span></h2>
<p class="paragraph"></p>
<ul>
<li><a href="#HGetthetarball">Get the tarball</a></li>
<li><a href="#HBuildthetarballfromSVN">Build the tarball from
SVN</a></li>
<li><a href="#HExtraction">Extraction</a></li>
<li><a href="#HInstallation">Installation</a></li>
</ul>
<h3 class="heading-1-1"><span id="HGetthetarball">Get the
tarball</span></h3>
<p class="paragraph"></p>All tarballs can be downloaded from the OW2
forge: <span class="nobr"><a href=
"http://forge.objectweb.org/project/showfiles.php?group_id=274">http://forge.objectweb.org/project/showfiles.php?group_id=274</a></span>
<p class="paragraph"></p>If you want the last SVN snapshot, please choose:
<span class="nobr"><a href=
"http://forge.objectweb.org/svnsnapshots/lemonldap-svn-latest.tar.gz">http://forge.objectweb.org/svnsnapshots/lemonldap-svn-latest.tar.gz</a></span>
<p class="paragraph"></p><strong class="strong">Warning</strong>: the
contents of the SVN tarball are not the same as the official tarballs.
Please see the next chapter to learn how build an official tarball from
SVN files.
<h3 class="heading-1-1"><span id="HBuildthetarballfromSVN">Build the
tarball from SVN</span></h3>
<p class="paragraph"></p>Either <span class="wikiexternallink"><a href=
"http://forge.objectweb.org/plugins/scmsvn/index.php?group_id=274">checkout
or export the SVN repository</a></span>, or <span class=
"wikiexternallink"><a href=
"http://forge.objectweb.org/svnsnapshots/lemonldap-svn-latest.tar.gz">extract
the SVN tarball</a></span> to get the SVN files on your disk.
<p class="paragraph"></p>Then go to build directory:
<div class="code">
<pre>
$ cd trunk/build/lemonldap-ng
</pre>
</div><br />
<br />
And run the "dist" target:
<div class="code">
<pre>
$ make dist
</pre>
</div><br />
<br />
The generated tarball is in the current directory.
<h3 class="heading-1-1"><span id=
"HExtraction">Extraction</span></h3><br />
<br />
Just run the tar command:
<div class="code">
<pre>
$ tar zxvf lemonldap-ng-*.tar.gz
</pre>
</div>
<h3 class="heading-1-1"><span id=
"HInstallation">Installation</span></h3><br />
<br />
First check and install the <span class="wikilink"><a href=
"3.1-Install-prerequesites.html">prerequisites</a></span>.<br />
<br />
For full install:<br />
<br />
<div class="code">
<pre>
$ cd lemonldap-ng-*
$ make
$ make configure
$ make test
$ sudo make install
</pre>
</div>
<p class="paragraph"></p>You can modify location of default storage
configuration file in configure target:
<div class="code">
<pre>
$ sudo make configure STORAGECONFFILE=/etc/lemonldap-ng/lemonldap-ng.ini
</pre>
</div><br />
<br />
You can choose other Makefile targets:
<ul class="star">
<li>Perl libraries install :
<ul class="star">
<li>install_libs (all Perl libraries)</li>
<li>install_portal_libs</li>
<li>install_manager_libs</li>
<li>install_handler_libs</li>
</ul>
</li>
<li>Binaries install :
<ul class="star">
<li>install_bin (/usr/local/lemonldap-ng/bin)</li>
</ul>
</li>
<li>Web sites install :
<ul class="star">
<li>install_site (all sites including install_doc_site)</li>
<li>install_portal_site (/usr/local/lemonldap-ng/htdocs/portal)</li>
<li>install_manager_site
(/usr/local/lemonldap-ng/htdocs/manager)</li>
<li>install_handler_site (/usr/local/lemonldap-ng/handler)</li>
</ul>
</li>
<li>Documentation install :
<ul class="star">
<li>install_doc_site (/usr/local/lemonldap-ng/htdocs/doc)</li>
<li>install_examples_site (/usr/local/lemonldap-ng/examples)</li>
</ul>
</li>
</ul>You can also pass parameters to the make install command, with this
syntax:
<div class="code">
<pre>
$ sudo make install PARAM=VALUE PARAM=VALUE ...
</pre>
</div><br />
<br />
Available parameters are:
<ul class="star">
<li><strong class="strong">ERASECONFIG</strong>: set to 0 if you want to
keep your configuration files (default: 1)</li>
<li><strong class="strong">DESTDIR</strong>: only for packaging, install
the product in a jailroot (default: "")</li>
<li><strong class="strong">PREFIX</strong>: installation directory
(default: /usr/local)</li>
<li><strong class="strong">STORAGECONFFILE</strong>: location of default
storage configuration file (default:
/usr/local/lemonldap-ng/etc/lemonldap-ng.ini)</li>
<li><strong class="strong">CRONDIR</strong>: Cronfile directory
(default: $PREFIX/etc/lemonldap-ng/cron.d)</li>
<li><strong class="strong">APACHEUSER</strong>: user running Apache</li>
<li><strong class="strong">APACHEGROUP</strong>: group running
Apache</li>
<li><strong class="strong">DNSDOMAIN</strong>: Main DNS domain (default:
example.com)</li>
<li><strong class="strong">LDAPHOST</strong>: LDAP server (default:
localhost)</li>
<li><strong class="strong">LDAPPORT</strong>: LDAP port (default:
389)</li>
<li><strong class="strong">LDAPSUFFIX</strong>: LDAP suffix (default:
dc=example,dc=com)</li>
<li><strong class="strong">APACHEVERSION</strong>: Apache major version
(default: 2)</li>
<li><strong class="strong">VHOSTLISTEN</strong>: how listen parameter is
configured for virtual hosts in Apache (default: *:80)</li>
<li><strong class="strong">WITHLA</strong>: install Liberty Alliance
portal (default: 0)</li>
</ul>
</div>
<p class="footer"><a href="index.html">Index</a></p>
</body>
</html>
<?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 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation:
3.3-Install-from-debian-packages.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=
"HInstallationonDebian2FUbuntuwithpackages">Installation on Debian/Ubuntu
with packages</span></h2>
<p class="paragraph"></p>
<ul>
<li><a href="#HGetthepackages">Get the packages</a></li>
<li><a href="#HBuildyourpackage">Build your package</a></li>
<li><a href="#HInstallpackageswithaptget">Install packages with
apt-get</a></li>
<li><a href="#HInstallpackageswithdpkg">Install packages with
dpkg</a></li>
<li><a href="#HFilelocation">File location</a></li>
<li><a href="#HChangedefaultDNSdomain">Change default DNS
domain</a></li>
</ul>
<h3 class="heading-1-1"><span id="HGetthepackages">Get the
packages</span></h3>
<p class="paragraph"></p>If you run Debian lenny (testing) or sid
(unstable), the LemonLDAP::NG packages are directly installable:
<div class="code">
<pre>
# apt-cache search lemonldap-ng
</pre>
</div><br />
<br />
Else you will have to download them first, from this location:
<span class="wikiexternallink"><a href=
"http://packages.debian.org/search?keywords=lemonldap-ng">http://packages.debian.org/search?keywords=lemonldap-ng</a></span>.<br />
<br />
For example:
<div class="code">
<pre>
# wget <span class="nobr"><a href=
"http://ftp.de.debian.org/debian/pool/main/l/lemonldap&amp;#45;ng/lemonldap&amp;#45;ng_0.9.2&amp;#45;1_all.deb">http://ftp.de.debian.org/debian/pool/main/l/lemonldap-ng/lemonldap-ng_0.9.2-1_all.deb</a></span>
# wget <span class="nobr"><a href=
"http://ftp.de.debian.org/debian/pool/main/l/lemonldap&amp;#45;ng/liblemonldap&amp;#45;ng&amp;#45;conf&amp;#45;perl_0.9.2&amp;#45;1_all.deb">http://ftp.de.debian.org/debian/pool/main/l/lemonldap-ng/liblemonldap-ng-conf-perl_0.9.2-1_all.deb</a></span>
# wget <span class="nobr"><a href=
"http://ftp.de.debian.org/debian/pool/main/l/lemonldap&amp;#45;ng/liblemonldap&amp;#45;ng&amp;#45;portal&amp;#45;perl_0.9.2&amp;#45;1_all.deb">http://ftp.de.debian.org/debian/pool/main/l/lemonldap-ng/liblemonldap-ng-portal-perl_0.9.2-1_all.deb</a></span>
# wget <span class="nobr"><a href=
"http://ftp.de.debian.org/debian/pool/main/l/lemonldap&amp;#45;ng/liblemonldap&amp;#45;ng&amp;#45;handler&amp;#45;perl_0.9.2&amp;#45;1_all.deb">http://ftp.de.debian.org/debian/pool/main/l/lemonldap-ng/liblemonldap-ng-handler-perl_0.9.2-1_all.deb</a></span>
# wget <span class="nobr"><a href=
"http://ftp.de.debian.org/debian/pool/main/l/lemonldap&amp;#45;ng/liblemonldap&amp;#45;ng&amp;#45;manager&amp;#45;perl_0.9.2&amp;#45;1_all.deb">http://ftp.de.debian.org/debian/pool/main/l/lemonldap-ng/liblemonldap-ng-manager-perl_0.9.2-1_all.deb</a></span>
</pre>
</div>
<p class="paragraph"></p>Older versions are available on our OW2 Debian
repository:
<div class="code">
<pre>
deb <span class="nobr"><a href=
"http://lemonldap.objectweb.org/NG/debian">http://lemonldap.objectweb.org/NG/debian</a></span> testing/
deb-src <span class="nobr"><a href=
"http://lemonldap.objectweb.org/NG/debian">http://lemonldap.objectweb.org/NG/debian</a></span> testing/
</pre>
</div>
<h3 class="heading-1-1"><span id="HBuildyourpackage">Build your
package</span></h3>
<p class="paragraph"></p>You can also get the LemonLDAP::NG archive
(<span class="wikiexternallink"><a href=
"http://forge.objectweb.org/project/showfiles.php?group_id=274">see
dowload section</a></span>) and make the package yourself:
<div class="code">
<pre>
$ tar xzf lemonldap-ng-*.tar.gz
$ cd lemonldap-ng-*
$ debuild
</pre>
</div>
<h3 class="heading-1-1"><span id="HInstallpackageswithaptget">Install
packages with apt-get</span></h3><br />
<br />
<div class="code">
<pre>
# apt-get install apache2 lemonldap-ng
</pre>
</div>
<h3 class="heading-1-1"><span id="HInstallpackageswithdpkg">Install
packages with dpkg</span></h3><br />
<br />
Before installing the packages, install <span class="wikilink"><a href=
"3.1-Install-prerequesites.html">dependencies</a></span>.<br />
<br />
Then:
<div class="code">
<pre>
# dpkg -i liblemonldap-ng-* lemonldap-ng*
</pre>
</div>
<h3 class="heading-1-1"><span id="HFilelocation">File location</span></h3>
<ul class="star">
<li>Configuration is in /etc/lemonldap-ng</li>
<li>LemonLDAP::NG configuration (edited by the Manager) is in
/var/lib/lemonldap-ng/conf/</li>
<li>All Perl modules are in the VENDOR perl directory</li>
<li>All Perl scripts/pages are in /var/lib/lemonldap-ng/</li>
<li>All static content (examples, CSS, images, etc.) is in
/usr/share/lemonldap-ng/</li>
</ul>
<h3 class="heading-1-1"><span id="HChangedefaultDNSdomain">Change default
DNS domain</span></h3><br />
<br />
By default, DNS domain is "example.com". You can change it quick with a
sed command. For example, we change it to ow2.org:<br />
<br />
<div class="code">
<pre>
# sed -i 's/example.com/ow2.org/g' /etc/lemonldap-ng/apache2.conf /etc/lemonldap-ng/apps-list.xml /<span class="java-keyword">var</span>/lib/lemonldap-ng/conf/lmConf-1 /etc/lemonldap-ng/apply.conf /<span class="java-keyword">var</span>/lib/lemonldap-ng/test/index.pl
</pre>
</div>
</div>
<p class="footer"><a href="index.html">Index</a></p>
</body>
</html>
<?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 25 March 2009), see www.w3.org" />
<title>Lemonldap::NG documentation:
3.3-Install-from-redhat-packages.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=
"HInstallationonRedHat2FCentOS">Installation on RedHat/CentOS</span></h2>
<p class="paragraph"></p>
<ul>
<li><a href="#HRPMsorganization">RPMs organization</a></li>
<li><a href="#HGetthepackages">Get the packages</a></li>
<li><a href="#HBuildyourpackages">Build your packages</a></li>
<li><a href="#HPackageGPGsignature">Package GPG signature</a></li>
<li><a href="#HInstallpackageswithyum">Install packages with
yum</a></li>
<li><a href="#HInstallpackageswithrpm">Install packages with
rpm</a></li>
<li><a href="#HInstalljustonecomponent">Install just one
component</a></li>
<li><a href="#HFilelocation">File location</a></li>
<li><a href="#HChangedefaultDNSdomain">Change default DNS
domain</a></li>
</ul>
<h3 class="heading-1-1"><span id="HRPMsorganization">RPMs
organization</span></h3>
<p class="paragraph"></p>LemonLDAP::NG provides many RPMs :
<ul class="star">
<li>lemonldap-ng: meta-package, contains no file but dependencies on
other packages</li>
<li>lemonldap-ng-doc: contains HTML documentation and project docs
(README, etc.)</li>
<li>lemonldap-ng-conf: contains default configuration (DNS domain:
example.com)</li>
<li>lemonldap-ng-test: contains sample CGI test page</li>
<li>lemonldap-ng-handler: contains Apache Handler implementation
(agent)</li>
<li>lemonldap-ng-manager: contains administration interface and session
explorer</li>
<li>lemonldap-ng-portal: contains authentication portal and menu</li>
<li>perl-Lemonldap-NG-Common: CPAN - Shared modules</li>
<li>perl-Lemonldap-NG-Handler: CPAN - Handler modules</li>
<li>perl-Lemonldap-NG-Manager: CPAN - Manager modules</li>
<li>perl-Lemonldap-NG-Portal: CPAN - Portal modules</li>
</ul>This schema shows the dependencies between modules:
<p class="paragraph"></p><img src="lemonldap-ng-packages.png" alt=
"lemonldap-ng-packages.png" />
<h3 class="heading-1-1"><span id="HGetthepackages">Get the
packages</span></h3>
<p class="paragraph"></p>For now, RPMS are only available in the
<span class="wikiexternallink"><a href=
"http://forge.objectweb.org/project/showfiles.php?group_id=274">download
section of lemonldap project on OW2 forge</a></span>. The first RPMS came
with version 0.9.3.
<h3 class="heading-1-1"><span id="HBuildyourpackages">Build your
packages</span></h3>
<ul class="star">
<li>Install rpm-build package</li>
<li>Install all build dependencies (see BuildRequires in
lemonldap-ng.spec)</li>
<li>Put lemonldap-ng.spec in %_topdir/SPECS</li>
<li>Put LemonLDAP::NG tarball in %_topdir/SOURCES</li>
<li>Edit ~/.rpmmacros and set your build parameters (example for
RHEL5):</li>
</ul>
<div class="code">
<pre>
%_topdir /home/user/build
%dist .el5
%rhel 5
</pre>
</div>
<ul class="star">
<li>Go to %_topdir</li>
<li>Do rpmbuild -ba SPECS/lemonldap-ng.spec</li>
</ul>
<h3 class="heading-1-1"><span id="HPackageGPGsignature">Package GPG
signature</span></h3><br />