Differences

This shows you the differences between two versions of the page.

--- plugins:mailman [2014/08/01 01:19]
nuxwin
+++ plugins:mailman [2017/07/03 09:44] (current)
nuxwin
@@ Line 1: / Line 1: @@
-======Mailman Plugin======
+<markdown>
+# i-MSCP Mailman plugin
-=====Introduction=====
+Provides mailing-lists through GNU Mailman software.
+</markdown>
+<WRAP center round important 60%>
+**Bear in mind that this documentation is for the last available version. If you use an older version, you must refer to the README.md file inside the plugin archive.**
+</WRAP>
+<markdown>
+## Requirements
-This plugin allow customers to create mailing list through i-MSCP. This plugin provide a bridge between i-MSCP and the Mailman software.
+- i-MSCP Serie ≥ 1.4.x
-=====Requirements=====
+## Installation
-  * i-MSCP >= 1.1.11 (plugin API >= 0.2.10)
+. Be sure that all requirements as stated in the requirements section are met
-  * Mailman (as provided by Debian/Ubuntu packages)
+. Upload the plugin through the plugin management interface
+. Edit the plugin configuration file according your needs
+. Install the plugin through the plugin management interface
-=====Installation=====
+Note that depending on your system, installation can take-up several minutes.
+You must be a bit patient and never short-cirtuit the process.
-**1.** Install needed Debian/Ubuntu package
+### Default mailman list
-	# aptitude update && aptitude install mailman
+The default `mailman` site list is automatically created with an auto-generated
+password. That password is sent to the mail account of the i-MSCP master
+administrator. The administrator can update password of the list through its
+own mailman interface at `http(s)://<control_panel:port>/mailman` URL.
-**2.** Create the mailman site list
+Note that the system hostname must be resolvable, else, the mail won't be
+delivered.
-	# newlist mailman
+## Update
-<WRAP center round important 80%>
+. Be sure that all requirements as stated in the requirements section are met
+. Backup your plugin configuration file if needed
+. Upload the plugin through the plugin management interface
-**This is really needed. Without this list, mailman will refuse to start.**
+Note that depending on your system, update can take-up several minutes. You
-</WRAP>
+You must be a bit patient and never short-cirtuit the process.
+### Restore you plugin configuration file if needed
+. Restore your plugin configuration file (compare it with the new version first)
+. Update the plugin list through the plugin management interface
+## Plugin translation
+You can translate this plugin using a gettext translation editor such as
+`Poedit`. Translation files are located under the `./l10n` directory, inside of
+the plugin archive. Once translated you can send us your translation file
+(po file) for integration in future release.
+Note that if no translation file exists for your localization in the
+`./l10n/po` directory, you must create it first from the `l10n/Mailman.pot`
+file. Be aware that your file must be `UTF-8`, else, it won't be accepted.
+## Troubleshooting
+### Couldn't create new list via control panel /mailman/create URL
+If you're upgrading from an older version, the sitewide password could not
+have been set yet. You can set the sitewide password as follow:
+    # /usr/lib/mailman/bin/mmsitepass <yourpassword>
+Once done, you should be able to create new lists through the `/mailman/create`
+control panel URL.
+### Couldn't write aliases.db or virtual-mailman.db errors
-**3.** Restart mailman
+In some situations, permissions to those files could have been reseted. You can
+set correct permissions as follow:
-	# service mailman restart
+    # cd /var/lib/mailman/data
+    # rm -f aliases* virtual-mailman*
+    # touch aliases virtual-mailman
+    # postalias aliases
+    # postmap virtual-mailman
+    # chown list:list aliases* virtual-mailman*
+    # chmod 0664 aliases* virtual-mailman*
-**4.** Plugin upload and installation
+Once done, don't forget to regenerate alias entries as follow
-  *  Download the Mailman plugin archive through the plugin store
+    # sg list -c /usr/lib/mailman/bin/genaliases
-  *  Login into the panel as admin and go to the plugin management interface
-  *  Upload the Mailman plugin archive
-  *  Install the plugin
-=====Update=====
+See also [LP: 1696066](https://bugs.launchpad.net/mailman/+bug/1696066)
-  *  Download the Mailman plugin archive through the plugin store
+### Wrong URL in email notification of administrator lists
-  *  Login into the panel as admin and go to the plugin management interface
-  *  Upload the Mailman plugin archive
-=====Known bugs=====
+Because there is not way to setup different patterns for Mailman URL hosts, any
+link appearing in administrator list email notifications will refers to control
+panel URL without the port, excepted for mail sent by the plugin itself.
-  * [[http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=603904|Debian Related - wrong permissions, causes archiving to fail]]
+There is two ways to solve the problem:
-=====License=====
+- Make use of the PanelRedirect plugin (not recommended)
+- Setup the control panel hostname as customer domain (or subdomain), and
+  enable the proxy feature as follow:
+   - URL forwarding: Yes
+   - Forward to URL: `http://<panel.domain.tld>:8880/` or
+     `https://<panel.domain.tld>:8443/` if SSL is enabled for the control panel
+   - Forward type: `PROXY` `Preserve Host`
-  i-MSCP Mailman plugin
+By doing this, the control panel will be available on standard HTTP ports and
-  Copyright (C) 2013-2014 Laurent Declercq <[email protected]>
+the problem of links in administrator list email notifications will be solved.
-  This library is free software; you can redistribute it and/or
-  modify it under the terms of the GNU Lesser General Public
-  License as published by the Free Software Foundation; either
-  version 2.1 of the License, or (at your option) any later version.
-  This library is distributed in the hope that it will be useful,
-  but WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-  Lesser General Public License for more details.
-  You should have received a copy of the GNU Lesser General Public
-  License along with this library; if not, write to the Free Software
-  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
- See [[http://www.gnu.org/licenses/lgpl-2.1.txt|LGPL v2.1]]
+Note that for the second option, you need at least i-MSCP 1.4.4 version in
+which a bug regarding the `redirect` feature has been fixed.
-=====Sponsors=====
+## Sponsors
-The development of this plugin has been sponsored by:
+ - IP-Projects GmbH & Co. KG - https://www.ip-projects.de
+ - Retail Service Management - http://www.retailservicesystems.com
-  * [[https://www.ip-projects.de|IP-Projects GmbH & Co. KG]]
+## License
-  * [[http://www.retailservicesystems.com|Retail Service Management]]
-=====Author=====
+    i-MSCP Mailman plugin
-  * Laurent Declercq <[email protected]>
+    @author Laurent Declercq <[email protected]>
+    @copyright (C) 2013-2017 Laurent Declercq <[email protected]>
+    @license i-MSCP License <https://www.i-mscp.net/license-agreement.html>
-**Thank you for using this plugin.**
+See the LICENSE file inside the archive for further details.
+</markdown>

i-MSCP Documentation

User Tools

Site Tools

Differences

Page Tools