Imported Upstream version 3.1
[squirrelmail-change-pass.git] / doc / INSTALL
1 Installing change_pass
2 ======================
3 0) NOTE: This plugin is not needed for SquirrelMail 1.5.0 or above.
4    The functionality it provides is already included in the
5    change_password plugin that is part of 1.5.x.
6
7    This plugin requires SquirrelMail 1.4.20 or later (or 1.4.0+ and
8    Compatibility 2.0.16).
9
10 1) Start with untaring the file into the plugins directory.
11    Here is an example for the 3.1 version of the change_pass plugin.
12
13   $ cd plugins
14   $ tar -zxf change_pass-3.1-1.4.0.tar.gz
15
16 2) By default, the plugin will connect to the IMAP server configured
17    for SquirrelMail on port 106 to change passwords.
18    If you need to change any of the following:
19      IP address of your poppass server
20      poppass server port number (if not 106)
21      minimum or maximum password length
22    you will need to create a configuration file.
23
24    Decide if you want to store the plugin configuration file
25    in the plugin directory or in the main SquirrelMail config
26    directory.
27
28    A) To store the configuration file in the plugin directory,
29       change into the change_pass directory, copy config_example.php
30       to config.php and edit config.php, making adjustments as
31       you deem necessary.
32
33      $ cd change_pass
34      $ cp config_example.php config.php
35      $ vi config.php
36
37    B) To store the configuration file in the main SquirrelMail
38       config directory, change into the change_pass directory,
39       copy config_example.php to ../../config/config_change_pass.php
40       and edit ../../config/config_change_pass.php, making
41       adjustments as you deem necessary.
42
43      $ cd change_pass
44      $ cp config_example.php ../../config/config_change_pass.php
45      $ vi ../../config/config_change_pass.php
46
47 3) Go to your config directory and run conf.pl.  Choose
48    option 8 and move the plugin from the "Available Plugins"
49    category to the "Installed Plugins" category.  Save and
50    exit.
51
52   $ cd ../../../../config/
53   $ ./conf.pl
54
55 4) Translations are not included in this package.  To get a
56    translation, download the language pack needed from:
57
58        http://www.squirrelmail.org/download.php