added docs for login page
This commit is contained in:
parent
ca78b15377
commit
ca823bf0f5
|
@ -22,7 +22,7 @@ the library files.<br>
|
|||
<td style="vertical-align: top; width: 33%;">
|
||||
<h2>Web pages:</h2>
|
||||
<ul>
|
||||
<li>Login<br>
|
||||
<li><a href="login.htm">Login</a><br>
|
||||
</li>
|
||||
<li><a href="file:///daten/cvs/lam/docs/devel/config_pages.htm">Configuration</a></li>
|
||||
<li><a href="file:///daten/cvs/lam/docs/devel/lists.htm">Account
|
||||
|
|
|
@ -0,0 +1,70 @@
|
|||
<!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>Login</title>
|
||||
<link rel="stylesheet" type="text/css" href="style/layout.css">
|
||||
</head>
|
||||
<body>
|
||||
<h1 style="text-align: center;">Login<br>
|
||||
</h1>
|
||||
<div style="text-align: center;"><br>
|
||||
</div>
|
||||
<div style="text-align: center;"><br>
|
||||
<div style="text-align: left;">The <span style="font-style: italic;">login</span>
|
||||
page is the first page the user sees when opening LAM. It manages LDAP
|
||||
authentication and checks the environment of the user.<br>
|
||||
<br>
|
||||
<br>
|
||||
<h2>login.php</h2>
|
||||
The login page offers authentication, language selection and profile
|
||||
selection. There are also some environment checks.<br>
|
||||
<br>
|
||||
<h3>Authentication</h3>
|
||||
The list of possible users is loaded from the current active profile.
|
||||
Only the RDN value is offered for selection by the user.<br>
|
||||
When the user submits his password then a new <span
|
||||
style="font-style: italic;">Ldap</span> object is created and LAM
|
||||
tries to connect to the LDAP server.<br>
|
||||
If the connection was successful the user is forwarded to the main
|
||||
frame (main.php). The session variable <span
|
||||
style="font-weight: bold; font-style: italic;">$_SESSION['loggedIn']</span>
|
||||
is set to <span style="font-style: italic;">true</span>. This informs
|
||||
the other PHP scripts that a valid user is connected (e.g. the user is
|
||||
allowed to create account profiles).<br>
|
||||
<br>
|
||||
<h3>Language selection</h3>
|
||||
The list of possible languages is read from <span
|
||||
style="font-weight: bold;">config/language</span>. The current active
|
||||
profile defines the preselected language and the language of the login
|
||||
page itself.<br>
|
||||
<br>
|
||||
<h3>Profile selection<br>
|
||||
</h3>
|
||||
The user can change the active configuration profile at login. A list
|
||||
of possible profiles is retrieved by <span
|
||||
style="font-weight: bold; font-style: italic;">getConfigProfiles()</span>.<br>
|
||||
If the profile is changed then the login replaces the config object in <span
|
||||
style="font-weight: bold; font-style: italic;">$_SESSION['config']</span>
|
||||
by a new one. Then the main login page is loaded and uses the new
|
||||
values.<br>
|
||||
<br>
|
||||
<h3>Environment checks</h3>
|
||||
LAM checks if all needed PHP extensions are installed.<br>
|
||||
<ul>
|
||||
<li><span style="font-weight: bold;">LDAP:</span> PHP needs LDAP
|
||||
support</li>
|
||||
<li><span style="font-weight: bold;">MHash:</span> needed for
|
||||
password creation</li>
|
||||
<li><span style="font-weight: bold;">Gettext:</span> needed for
|
||||
translation<br>
|
||||
</li>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
Loading…
Reference in New Issue