moving functions to separate file, adding configuration files
[squirrelmail.git] / plugins / README.plugins
CommitLineData
7e3e4019 1Plugins
2=======
3
4To understand more about plugins, read doc/plugin.txt
5
6For the impatient, here is an extremely brief overview of how to
7install plugins.
8
9 1. Change to the plugins directory.
10
11 $ cd plugins/
12
13 2. Unarchive the plugin.
14
15 $ tar -zxvf /home/me/myplugin.tar.gz
16
17 3. Note the directory that the plugin was created into. For this
18 example, we will assume it was put in the directory: myplugin/.
e0495695 19
8da3c3bf 20 4. Read the README, INSTALL or other documentation in your new plugin.
21 Follow any important configuration instructions inside (about half
22 the time there are none, sometimes they are extensive).
23
24 $ cd myplugin/
25 $ more README
7e3e4019 26
e0495695 27 5. Go to the config directory and run conf.pl
7e3e4019 28
29 $ cd ../../config/
30 $ ./conf.pl
31
e0495695 32 6. Choose option 8 and proceed to add the new plugin following
7e3e4019 33 the instructions there. Save and exit, and your plugin should
34 be in place.