File: //usr/local/mailchannels/README.md
# MailChannels cPanel Plugin V3
### Installation
To install the plugin on a cPanel instance log into the terminal on the cPanel instance and run the following command:
wget https://s3.amazonaws.com/mailchannels-reseller/plugins/mailchannels-cpanel-v3-installer && bash mailchannels-cpanel-v3-installer
### Compatibility
This plugin requires cPanel versions 11.68 and greater and php 5.6 and greater.
### Upgrading from MailChannels cPanel Plugin v2
If you are upgrading from the previous v2 cPanel plugin you must uninstall the plugin first before installing the V3
plugin. The v3 installer will ask you if you'd like to uninstall the v2 plugin if it's there. If you say no, the installer
will exit and you must uninstall the v2 plugin yourself before proceeding.
### Uninstalling
Run "/usr/local/mailchannels/bin/uninstall.sh" as a superuser to uninstall the plugin. If the script is run without any flags
the log files (located at /var/log/mailchannels) and the configuration files (located at /etc/mailchannels) will remain.
Providing the --purge option to the uninstall script will remove these files.
If the uninstaller detects that MailChannels outbound has been enabled (resulting in outbound email being filtered through
mailchannels) it will ask if it should disable it. Answering yes will set your outbound mail settings back to what it was
before installing the plugin.
If the purge option is provided and MailChannels outbound has been detected, the uninstall script will disable MailChannels
outbound without prompt.