Correct doc location
[squirrelmail.git] / plugins / README.plugins
CommitLineData
7e3e4019 1Plugins
2=======
3
3b2ad8c6 4To understand more about plugins, read:
5
6 http://squirrelmail.org/docs/admin/admin-7.html#ss7.1
7 http://squirrelmail.org/docs/devel/devel-4.html
8
7e3e4019 9
10For the impatient, here is an extremely brief overview of how to
11install plugins.
12
13 1. Change to the plugins directory.
14
15 $ cd plugins/
16
17 2. Unarchive the plugin.
18
19 $ tar -zxvf /home/me/myplugin.tar.gz
20
21 3. Note the directory that the plugin was created into. For this
22 example, we will assume it was put in the directory: myplugin/.
e0495695 23
8da3c3bf 24 4. Read the README, INSTALL or other documentation in your new plugin.
25 Follow any important configuration instructions inside (about half
26 the time there are none, sometimes they are extensive).
27
28 $ cd myplugin/
29 $ more README
7e3e4019 30
e0495695 31 5. Go to the config directory and run conf.pl
7e3e4019 32
33 $ cd ../../config/
34 $ ./conf.pl
35
e0495695 36 6. Choose option 8 and proceed to add the new plugin following
7e3e4019 37 the instructions there. Save and exit, and your plugin should
38 be in place.
6f0834fb 39
40The following plugins are "core" plugins; that is, plugins shipped with
41the SquirrelMail distribution. Unless you are a developer and know what
42you are doing, you should not replace these plugins with other versions.
43
44- abook_take
45- administrator
46- bug_report
47- calendar
48- change_password
49- filters
50- fortune
51- info
52- listcommands
53- mail_fetch
54- message_details
55- newmail
56- plist
57- sent_subfolders
58- spamcop
59- squirrelspell
60- translate