added documentation of config.inc
This commit is contained in:
parent
c7d57fe2eb
commit
a92de8d971
|
@ -0,0 +1,61 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta content="text/html; charset=ISO-8859-15"
|
||||||
|
http-equiv="content-type">
|
||||||
|
<title>config.inc</title>
|
||||||
|
<link rel="stylesheet" type="text/css" href="style/layout.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1 style="text-align: center;">config.inc</h1>
|
||||||
|
<br>
|
||||||
|
<br>
|
||||||
|
This file includes all functions needed to manage configuration
|
||||||
|
profiles. It includes classes for the profiles itself and the master
|
||||||
|
configuration (default profile, master password, etc.).<br>
|
||||||
|
<br>
|
||||||
|
There are also two global functions for general use: <span
|
||||||
|
style="font-style: italic;">setlanguage</span> and <span
|
||||||
|
style="font-style: italic;">metarefresh</span><br>
|
||||||
|
<br>
|
||||||
|
<h2>Meta refresh</h2>
|
||||||
|
The global function <span
|
||||||
|
style="font-weight: bold; font-style: italic;">metaRefresh()</span>
|
||||||
|
takes an URL as argument and prints all HTML code needed for a meta
|
||||||
|
refresh to this URL.<br>
|
||||||
|
<br>
|
||||||
|
<h2>Language</h2>
|
||||||
|
LAM uses <span style="font-style: italic;">gettext</span> to translate
|
||||||
|
the HTML pages to the different languages. Therefore some preferences
|
||||||
|
need to be set on every page load. This is done by <span
|
||||||
|
style="font-style: italic; font-weight: bold;">setlanguage()</span>.<br>
|
||||||
|
The function should be called directly after starting the session.<br>
|
||||||
|
<br>
|
||||||
|
The list of possible languages is stored in <span
|
||||||
|
style="font-style: italic;">config/language</span>. It includes the
|
||||||
|
locale name, the character encoding an the language name.<br>
|
||||||
|
All languages use UTF-8 as encoding because LDAP also stores values in
|
||||||
|
this format.<br>
|
||||||
|
<br>
|
||||||
|
<h2>Configuration profiles</h2>
|
||||||
|
Each configuration profile is saved in a single file in <span
|
||||||
|
style="font-weight: bold;">config/</span>.<br>
|
||||||
|
<br>
|
||||||
|
There are two types of configuration options:<br>
|
||||||
|
<ul>
|
||||||
|
<li>Static options (LDAP server settings, etc.)<br>
|
||||||
|
</li>
|
||||||
|
<li>Module options (UID/GID ranges)<br>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
All static options have a describing comment in the configuration file
|
||||||
|
to make it easier for the user to modify the values. The dynamic
|
||||||
|
options provided by the modules do not include a comment.<br>
|
||||||
|
<br>
|
||||||
|
<h2>Master configuration file</h2>
|
||||||
|
LAM stores the default configuartion profile and a master password in <span
|
||||||
|
style="font-style: italic;">config/config.cfg</span>.<br>
|
||||||
|
The master password is verified when the user wants to create/delete
|
||||||
|
configuration profiles.<br>
|
||||||
|
</body>
|
||||||
|
</html>
|
|
@ -7,6 +7,10 @@
|
||||||
<body>
|
<body>
|
||||||
<div style="text-align: center;">
|
<div style="text-align: center;">
|
||||||
<h1>LDAP Account Manager - Code overview</h1>
|
<h1>LDAP Account Manager - Code overview</h1>
|
||||||
|
These documents are supposed to give developers who want to modify LAM
|
||||||
|
an overview of the codebase. It focuses mainly on what is done to
|
||||||
|
generate the HTML output and the most important functions provided by
|
||||||
|
the library files.<br>
|
||||||
<img src="images/lam_overview.png" width="877" height="620" border="0"
|
<img src="images/lam_overview.png" width="877" height="620" border="0"
|
||||||
align="middle" alt="overview"><br>
|
align="middle" alt="overview"><br>
|
||||||
<br>
|
<br>
|
||||||
|
@ -45,7 +49,7 @@ lists</a><br>
|
||||||
</li>
|
</li>
|
||||||
<li>Account profiles (profiles.inc)<br>
|
<li>Account profiles (profiles.inc)<br>
|
||||||
</li>
|
</li>
|
||||||
<li>Configuration (config inc)<br>
|
<li><a href="config.htm">Configuration (config inc)</a><br>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="file:///daten/cvs/lam/docs/devel/ldap.htm">LDAP
|
<li><a href="file:///daten/cvs/lam/docs/devel/ldap.htm">LDAP
|
||||||
(ldap.inc)</a><br>
|
(ldap.inc)</a><br>
|
||||||
|
|
Loading…
Reference in New Issue