Set the userdb path to be /etc/courier/userdb.
[hcoop/debian/courier-authlib.git] / README.html
CommitLineData
d9898ee8 1<?xml version="1.0" encoding="UTF-8"?>
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
5 <title>README</title>
6 <meta name="generator" content="amaya 8.6, see http://www.w3.org/Amaya/" />
7</head>
8
9<body>
10<h1>Courier Authentication Library</h1>
11
12<p>This is the Courier authentication library. Copies of this library code
13used to exist in other tarballs: Courier, Courier-IMAP, and SqWebMail.
14Building and installing any of these packages would've automatically
15installed this authentication code.</p>
16
17<p>The authentication library is now a separate, standalone package. This
18authentication library must now be installed, separately, before upgrading to
19the following builds (or if installing them for the first time): Courier
200.48, Courier-IMAP 4.0, and SqWebMail 5.0. See <a href="NEWS.html">NEWS</a>
21for more information.</p>
22
23<p>Download: <a target="_blank"
24href="http://www.courier-mta.org/download.php#authlib">http://www.courier-mta.org/download.php#authlib</a></p>
25
26<h2>Overview</h2>
27
28<p>The Courier authentication library provides authentication services for
29other Courier applications. In this context, the term "authentication" refers
30to the following functions:</p>
31<ol>
32 <li>Take a userid or a loginid, and a password. Determine whether the
33 loginid and the password are valid.</li>
34 <li>Given a userid, obtain the following information about the userid:
35 <ol type="A">
36 <li>The account's home directory.</li>
37 <li>The numeric system userid and groupid that owns all files
38 associated with this account.</li>
39 <li>The location of the account's maildir.</li>
40 <li>Any maildir quota defined for this account. See the Courier
41 documentation for more information on maildir quotas.</li>
42 <li>Other miscellaneous account-specific options.</li>
43 </ol>
44 </li>
45 <li>Change the password associated with a loginid.</li>
46 <li>Obtain a complete list of all loginids.</li>
47</ol>
48
49<p>The Courier authentication library provides alternative implementations of
50these authentication services:</p>
51<ol>
52 <li>Use the traditional system password files: <code>/etc/passwd</code> and
53 <code>/etc/shadow</code>, possibly in conjunction with the PAM
54 library.</li>
55 <li>Maintain all this information in a GDBM or a DB database. The GDBM or
56 the DB database is compiled from plain text files. Perl scripts provide a
57 simple interface for creating and editing the authentication information,
58 then a script compiles the plain text files into a database.</li>
59 <li>Use an LDAP server for authentication.</li>
60 <li>Use a table in a MySQL database for authentication.</li>
61 <li>Use a table in a PostgreSQL database for authentication.</li>
62</ol>
63
64<p>All Courier components that use this authentication library, therefore,
65will be able to authenticate E-mail accounts
66using any of the above methods.</p>
67
68<p>Additional information can be found in the <a
69href="INSTALL.html">INSTALL</a> file.</p>
70
71<p>The authentication API is <a href="authlib.html">documented</a>.</p>
72
73<h2>Further resources</h2>
74
75<p>Subscribe to the courier-users mailing list: <a
76href="http://lists.sourceforge.net/lists/listinfo/courier-users"><code>http://lists.sourceforge.net/lists/listinfo/courier-users</code></a>.</p>
77
78<p></p>
79</body>
80</html>