vmailmgrd backend site configuration is in config.php.
[squirrelmail.git] / plugins / change_password / README
1 Master Change Password plugin
2 -----------------------------
3
4 WHAT'S THIS?
5 This plugin is a general framework for enabling the user to
6 change his/her password. It allows for different backend
7 to perform this task on different systems.
8
9 STATUS
10 Development
11
12 CONFIGURATION
13 Edit the file config.php to set the backend you want to use.
14 Probably, you need to set some config vars in the backend too
15 (backend/<yourbackend>.php).
16
17 BACKENDS
18 - mysql
19
20 Default settings are supplied in backends/mysql.php.
21
22 You do not have to change any configuration vars in
23 backend/mysql.php - instead, create an array in config.php
24 containing the variable you want to override, for example:
25
26 To override the server name ($mysql_server), you would add
27 $mysql['server'] = 'remote_servername';
28 to config.php.
29
30
31 - merak
32
33 Default settings are supplied in backends/merak.php.
34
35
36 - poppassd
37
38 Default settings are supplied in backends/poppassd.php.
39
40
41 - vmailmgrd
42
43 Default settings are supplied in backends/vmailmgrd.php.
44
45 Site configuration is controlled in config.php $vmailmgrd
46 array. Backend uses 'vmail_inc_path', 'vm_tcphost',
47 'vm_tcphost_port' and 'cpw_vmailmgrd_8bitpw' array keys.
48
49 'vmail_inc_path' sets path to vmail.inc. 'vm_tcphost' sets
50 vmailmgrd tcp service ip address or dns name. Plugin uses
51 vmailmgrd socket, if it is not set. 'vm_tcphost_port' sets
52 port of vmailmrgd service. Plugin uses port 322, if it is
53 not set. 'cpw_vmailmgrd_8bitpw' controls use of 8bit
54 passwords. If it is not set, interface does not allow new
55 passwords with 8bit symbols.
56
57 $vmailmgrd['vmail_inc_path'] setting is required.
58
59 AUTHORS:
60 merak backend - Edwin van Elk <Edwin@eve-software.com>
61 mysql backend - Thijs Kinkhorst <kink@squirrelmail.org>
62 poppassd backend - Seth Randall <sethr@missoulafcu.org>
63 vmailmgrd backend - Tomas Kuliavas <tokul@users.sourceforge.net>
64
65 $Id$