postfixadmin/ADDITIONS/squirrelmail-plugin/INSTALL

Installing the postfixadmin Plugin
======================================

Requirements:
=============

 - PHP 5.[234].* with php5-xmlrpc installed (if available; it should be available by default anyway)
 - http access to a local/remote postfixadmin interface 
 - Zend Framework (1.12.x) - needs adding to the include path within common.php, 
   or installing in a system include path directory (e.g. /usr/share/php)
   (e.g. from within the directory containing this file ...
	wget https://packages.zendframework.com/releases/ZendFramework-1.12.3/ZendFramework-1.12.3-minimal.tar.gz 
	tar -zxf ZendFramework-1.12.3-minimal.tar.gz
	mv ZendFramework-1.12.3-minimal/library/Zend .    )
   NOTE: This plugin is _not compatible_ with Zend Framework version 2.x.

Installation :
==============

- Copy this code into the Squirrelmail plugins directory - your life will be easiest if it's in a directory called 'postfixadmin'
- Install Zend Framework (see above under Requirements for example)
- Edit config.php and specify the remote URL for the Postfixadmin XmlRpc service. 
- Edit common.php and (if you need to) change the include path(s) so they are correct.
- Edit the remote Postfixadmin's XmlRpc service config file and ensure 'xmlrpc_enabled' is set to boolean true.
- Enable the plugin through 'squirrelmail-configure' or 'config/conf.pl'.  
   Choose option 8 and move the plugin from the "Available Plugins"
   category to the "Installed Plugins" category.  Save and exit.

Security :
==========

- The XmlRpc client needs to get the user's mailbox password before it will be able to connect to the
  XmlRpc server (postfixadmin). The plugin prompts the user for their mailbox password, and caches it in their session
  ($_SESSION['password']). This password is then sent once on every page load to the remote XmlRpc server.

- You should consider doing any of the following :
 - Using https if the server and client are on seperate servers. This will probably require a signed certificate etc, and may require changes to the Zend_XmlRpc_Client's HttpClient.
 - Using something like stunnel to encrypt traffic between server(s).
list-virtual.php: - hand over $search to smarty templates templates/list-virtual_alias.tpl, templates/list-virtual_alias_domain.tpl: - add search result highlighting templates/list-virtual_mailbox.tpl: - add search result highlighting - move output of "Mailbox" / "Forward only" outside the foreach loop (was displayed once per mailbox alias target) css/default.css: - add style for ".searchresult" git-svn-id: https://svn.code.sf.net/p/postfixadmin/code/trunk@868 a1433add-5e2c-0410-b055-b7f2511e0802 14 years ago			`Installing the postfixadmin Plugin`
			`======================================`

			`Requirements:`
			`=============`

improve installation instructions git-svn-id: https://svn.code.sf.net/p/postfixadmin/code/trunk@1648 a1433add-5e2c-0410-b055-b7f2511e0802 11 years ago			`- PHP 5.[234].* with php5-xmlrpc installed (if available; it should be available by default anyway)`
			`- http access to a local/remote postfixadmin interface`
			`- Zend Framework (1.12.x) - needs adding to the include path within common.php,`
			`or installing in a system include path directory (e.g. /usr/share/php)`
			`(e.g. from within the directory containing this file ...`
			`wget https://packages.zendframework.com/releases/ZendFramework-1.12.3/ZendFramework-1.12.3-minimal.tar.gz`
			`tar -zxf ZendFramework-1.12.3-minimal.tar.gz`
			`mv ZendFramework-1.12.3-minimal/library/Zend . )`
INSTALL.TXT, ADDITIONS/squirrelmail-plugin/INSTALL - add required version of Zend Framework (1.12.x) and a warning that 2.x won't work (reported by seboulba on IRC) git-svn-id: https://svn.code.sf.net/p/postfixadmin/code/trunk@1699 a1433add-5e2c-0410-b055-b7f2511e0802 10 years ago			`NOTE: This plugin is _not compatible_ with Zend Framework version 2.x.`
list-virtual.php: - hand over $search to smarty templates templates/list-virtual_alias.tpl, templates/list-virtual_alias_domain.tpl: - add search result highlighting templates/list-virtual_mailbox.tpl: - add search result highlighting - move output of "Mailbox" / "Forward only" outside the foreach loop (was displayed once per mailbox alias target) css/default.css: - add style for ".searchresult" git-svn-id: https://svn.code.sf.net/p/postfixadmin/code/trunk@868 a1433add-5e2c-0410-b055-b7f2511e0802 14 years ago
			`Installation :`
			`==============`

improve installation instructions git-svn-id: https://svn.code.sf.net/p/postfixadmin/code/trunk@1648 a1433add-5e2c-0410-b055-b7f2511e0802 11 years ago			`- Copy this code into the Squirrelmail plugins directory - your life will be easiest if it's in a directory called 'postfixadmin'`
			`- Install Zend Framework (see above under Requirements for example)`
			`- Edit config.php and specify the remote URL for the Postfixadmin XmlRpc service.`
			`- Edit common.php and (if you need to) change the include path(s) so they are correct.`
			`- Edit the remote Postfixadmin's XmlRpc service config file and ensure 'xmlrpc_enabled' is set to boolean true.`
list-virtual.php: - hand over $search to smarty templates templates/list-virtual_alias.tpl, templates/list-virtual_alias_domain.tpl: - add search result highlighting templates/list-virtual_mailbox.tpl: - add search result highlighting - move output of "Mailbox" / "Forward only" outside the foreach loop (was displayed once per mailbox alias target) css/default.css: - add style for ".searchresult" git-svn-id: https://svn.code.sf.net/p/postfixadmin/code/trunk@868 a1433add-5e2c-0410-b055-b7f2511e0802 14 years ago			`- Enable the plugin through 'squirrelmail-configure' or 'config/conf.pl'.`
			`Choose option 8 and move the plugin from the "Available Plugins"`
			`category to the "Installed Plugins" category. Save and exit.`

			`Security :`
			`==========`

			`- The XmlRpc client needs to get the user's mailbox password before it will be able to connect to the`
			`XmlRpc server (postfixadmin). The plugin prompts the user for their mailbox password, and caches it in their session`
			`($_SESSION['password']). This password is then sent once on every page load to the remote XmlRpc server.`

			`- You should consider doing any of the following :`
			`- Using https if the server and client are on seperate servers. This will probably require a signed certificate etc, and may require changes to the Zend_XmlRpc_Client's HttpClient.`
			`- Using something like stunnel to encrypt traffic between server(s).`