[squirrelmail.git] / plugins / README.plugins

Plugins
=======

To understand more about plugins, read doc/plugin.txt

For the impatient, here is an extremely brief overview of how to
install plugins.

  1.  Change to the plugins directory.

        $ cd plugins/

  2.  Unarchive the plugin.

        $ tar -zxvf /home/me/myplugin.tar.gz

  3.  Note the directory that the plugin was created into.  For this
      example, we will assume it was put in the directory: myplugin/.
  
  4.  Read the README or other documentation in your new plugin.  Follow
      any important configuration instructions inside (usually there are
      none).

  5.  Go to the config directory and run conf.pl

        $ cd ../../config/
        $ ./conf.pl

  6.  Choose option 8 and proceed to add the new plugin following
      the instructions there.  Save and exit, and your plugin should
      be in place.
Commit	Line	Data
7e3e4019	1	Plugins
	2	=======
	3
	4	To understand more about plugins, read doc/plugin.txt
	5
	6	For the impatient, here is an extremely brief overview of how to
	7	install 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
	20	4. Read the README or other documentation in your new plugin. Follow
	21	any important configuration instructions inside (usually there are
	22	none).
7e3e4019	23
e0495695	24	5. Go to the config directory and run conf.pl
7e3e4019	25
	26	$ cd ../../config/
	27	$ ./conf.pl
	28
e0495695	29	6. Choose option 8 and proceed to add the new plugin following
7e3e4019	30	the instructions there. Save and exit, and your plugin should
7e3e4019	31	be in place.