HOW TO install ASSP Deluxe for cPanel plus ASSP 1.3.9 (final) (updated 23 July 2008)

Uninstallation is included at the end of this HOW TO ( here ).

• Installation requirements

Hardware requirements : You can install it also on old servers with 256 MB RAM . You can install/run it on VPS without problems.  firewall tcp port 55555 and 55553 opened (inbound and outbound) , required for the ASSP Web interface and Stats firewall tcp port 125 opened (only inbound)  Activate and install cPanelPro at http://pro.cpanel.net/activate/  (required to install ClamAV antivirus) Install Clamavconnector antivirus         WHM > cPanel > Addon Modules on cPanel 10,         WHM > Cpanel>Manage Plugins   on cPanel 11 Deactivate/Remove mailscanner if you are using it (otherwise it is redundant)( how to ). Deactivate/Remove rvskin anstispam if you are using it  (otherwise it is redundant).  Deactivate/remove any other spam/antivirus solution installed . Spamassassin/box trapper must be deactivated from WHM and cPanel theme/skins. If you have no confidence with terms like RBL/URIBL , Whitelist , Bayesian , delaying, I suggest you to read some assp wiki articles . You should have min. 1 domain name listed on WHM (account list) note ; are you installing "assp deluxe for cPanel" only to test performance ? . Note that ASSP starts with an empty bayesian database . The database is automatically (also if the user may  contribute to build it) created day by day based on what the users are doing on the server . So testing ASSP on a server with few accounts and few traffic, will not create an efficient bayesian database in the brief time , or it will be mature only after some days . If you'll follow carefully the post installation steps (which includes the usage of ASSP scoring mode ON,spambox plugin, delaying off) , ASSP will use several filters at the same time before blocking an email (assp scoring mode) , and also if the Bayesian filter will not be still mature after some day (due to few email traffic), ASSP should be already good/enough to block 80%-90% of your received spam . When your bayesian filter will be more mature, you can increase the Bayesian score contribute (we'll find detailed info on the faqs) to block 95%-99% received spam also with relaxed/default antispam setting and with a very low risk to lose a good email (in each case the email will not be lost if you activate the spambox plugin as recommended). some ASSP WHM features will be available only if you'll enable specific tools . For example if you would "EMAIL DAILY REPORTS" you should enable the spambox plugin using ASSP WHM or , another example , if you would see the "spambox" functionality on your users cPanel frontend  you should enable the spambox plugin on assp WHM.

Now you can start the installation . If it's your first "ASSP Deluxe for cPanel" installation , do not worry. If you are familiar executing  console commands and setting cronjobs the installation is easy to be completed. During the installation your clients will be able to send and receive email , you should only execute some EXIM restart . If you follow the installation step by step you'll not have problems at all. If something is not working or you fail some step please send a message to this email (include your licensed ip) and explain me the problem. At the end of installation you (or anyone who is installing ASSP for you) should apply the post installation steps .

INSTALLATION  (Time required to complete this installation, 20~30 minutes)

Only If you need to uninstall correctly mailscanner please read this

Deactivate/turn off    spamassassin
To deactivate spamassassin open WHM then select
Service Configuration > Service Manager and uncheck spamd as shown below
 

please be sure antirelayd service is running/enabled as shown below

With latest cPanel 11 versions (cPanel 11.23 RELEASE and above versions) antirelayd can be found in the Tailwatchd ; be sure Tailwatchd and Antirelayd are selected as shown below.

save Service Manager settings then go to
Server Configuration > Tweak settings  and uncheck spamassassin and boxtrapper as shown below, and save Tweak Settings.

AND go down to PHP , and select Ioncube .  Save Tweak Settings (on older cPanel versions you can find ioncube here
Server Configuration > Tweak settings > Software  )

With ASSP running all antispam/antivirus configurations configured at EXIM level will be redundant and useless.

As can you see from the image above , after the step 2 , all the email dictionary attacks are already blocked , most/all the SPAM should be blocked , and to EXIM (point 3) should reach only good email to be processed . So every antispam check executed at step 3 is useless . For this reason, you need a default/clean EXIM configuration ; all the spam/virus filtering work will be done by ASSP, and EXIM should work only as an MTA ( message transfer agent ) , any other duty will be useless.

Now, before cleaning exim configuration, create a backup of your current /etc/exim.conf   in this way

cp /etc/exim.conf /etc/exim.conf_old

It will be useful only if you'll decide to uninstall ASSP in the future.

Now , to "clean/reset exim.conf"  ,simply  Open WHM , go to "Service Configuration" , then "Exim Configuration Editor" , and click on "RESET ALL CONFIGS TO DEFAULT" .

Alternativelly to "clean/reset exim.conf" , Open WHM , go to "Service Configuration" , then "Exim Configuration Editor" ,
then "Advanced editor". You should empty all text boxes (ACL too , they should be recreated automatically **) , then click on "save". In some OS (for example on Trustix), the ACL sections are not re-created automatically from cPanel , in this case you should execute "reset ACL config to default" or  "RESET ALL CONFIGS TO DEFAULT" to recreate the ACL section .  
 

• Then , if you have cPanel 10 you should configure WHM > Exim Configuration editor in this way. 001#

  

 

• Or , if you have Cpanel 11 you should configure WHM > Exim Configuration editor in this way (all disabled except of "validate sender") . All disabled because all these checks will be redundant/useless with ASSP running (ASSP spam filtering is executed before exim) , as explained some row above .

  

 

Ok , now go to ssh console , execute following command to check your Perl version...

perl -v

if you have Perl version 5.8.7 or above you can continue (5.8.8 is required if you have cPanel 11)  . Otherwise execute /scripts/perlinstaller and check again the perl version. If /scripts/perlinstaller fails to update Perl go to http://layer1.cpanel.net download the latest Perl installer and install it.

Now execute following command to check your cPanel internal php version...

/usr/local/cpanel/3rdparty/bin/php -v

Only If you have a php version below 5.2.6  execute the command below . Only If you have php 5.2.6 or above skip the command below.

 

ln -s /usr/local/cpanel/3rdparty/bin/php /usr/local/cpanel/3rdparty/bin/php-cgi

Now check if you have ClamAV antivirus installed

clamd --v

or

/usr/sbin/clamd --v

if it returns ClamAV 0.91.1 or above you can continue
Otherwise you should install/upgrade clamavconnector using  WHM > Cpanel > plugins  ( WHM / ADD on modules on cPanel 10).
If you are using a custom clamAV installation I recommend you to remove it and use only  ClamAV provided by WHM/Cpanel.

Ok now create the folder /usr/local/assp in this way

mkdir /usr/local/assp

Now we install perl modules required by ASSP

cd /usr/local/assp;wget http://www.grscripts.com/assp/assp_modules_installer
chmod 700 assp_modules_installer;./assp_modules_installer;rm -f assp_modules_installer

Now we start with ASSP installation

cd /usr/local/assp
wget http://www.grscripts.com/131/ASSP_1.3.1-Install.zip
unzip -d /usr/local/assp /usr/local/assp/ASSP_1.3.1-Install.zip
mv --target-directory=/usr/local/assp /usr/local/assp/ASSP/*
mv --target-directory=/usr/local/assp /usr/local/assp/ASSP/.DS_Store

If  mv --target-directory is not accepted try this

mv /usr/local/assp/ASSP/* /usr/local/assp;mv /usr/local/assp/ASSP/.DS_Store /usr/local/assp

then execute

rm -rf /usr/local/assp/__MACOSX
rm -rf /usr/local/assp/ASSP;rm -f ASSP_1.3.1-Install.zip

 

Now we get latest ASSP version and ASSP configuration file (latest blue line)

cd /usr/local/assp
wget -r -nH --cut-dirs=10 http://www.grscripts.com/assp139/assp.tar.gz
tar xvzf assp.tar.gz;rm -f assp.tar.gz
chmod 700 assp.pl;chmod 755 rebuildspamdb.pl;chmod 755 repair.pl
wget -r -nH --cut-dirs=10 http://www.grscripts.com/135_50/assp.cfg

Now we create working ASSP files and folders

cd /usr/local/assp;mkdir pb;cd pb
touch denysmtp.txt;touch exportedextreme.txt;touch pbdb.black.db
touch pbdb.rbl.db;touch pbdb.white.db
cd /usr/local/assp;mkdir notspam;mkdir spam;mkdir errors
mkdir /usr/local/assp/errors/notspam;mkdir /usr/local/assp/errors/spam
chmod 700 /usr/local/assp/spam;chmod 700 /usr/local/assp/notspam;chmod 700 /usr/local/assp/errors

Now we install ASSP service files .

cd /usr/local/assp
wget  -r -nH --cut-dirs=10 http://www.grscripts.com/service/start
chmod 700 start
wget -r -nH --cut-dirs=10 http://www.grscripts.com/service/stop
chmod 700 stop
cd /etc/rc.d/init.d
wget -r -nH --cut-dirs=10 http://www.grscripts.com/service/assp
chmod 755 assp
cd /usr/local/assp

( note : ONLY If you have Trustix OS execute this too

cd /etc;mkdir rc.d;cd rc.d;mkdir init.d

cd /etc/rc.d/init.d
wget -r -nH --cut-dirs=10 http://www.grscripts.com/service/assp
chmod 755 assp

cd /etc/init.d;wget -r -nH --cut-dirs=10 http://www.grscripts.com/service/assp;chmod 755 assp
cd /usr/local/assp

)

Now we install ASSP Deluxe php scripts on /usr/local/assp/deluxe in this way

cd /usr/local/assp;mkdir deluxe;cd /usr/local/assp/deluxe
ln -s /etc/relayhosts /usr/local/assp/deluxe/relayhosts
wget -r -nH --cut-dirs=10 http://www.grscripts.com/assp150/deluxe/assp.tar.gz
tar xvzf assp.tar.gz;rm -f assp.tar.gz;chmod 755 *.*;chmod 755 *
chmod 666 *spam_lover;chmod 666 assp_catch_all;chmod 755 /usr/local/assp/rebuildspamdb.pl

Only if you have a 64 Bit OS you should execute following commands too (it will update the /ioncube folder with 64 bit encoders)

cd /usr/local/assp/deluxe/ioncube
wget -r -nH --cut-dirs=10 http://www.grscripts.com/ioncube64/ioncube64.tar.gz
tar xvzf ioncube64.tar.gz;rm -f ioncube64.tar.gz

WHM ASSP Deluxe for cPanel interface
Now you can install the WHM ASSP Deluxe for cPanel interface ; 

cd /usr/local/cpanel/whostmgr/docroot/cgi
wget -r -nH --cut-dirs=10 http://www.grscripts.com/asspwhm/whm.tar.gz
tar xvzf whm.tar.gz;rm -f whm.tar.gz

Only if you have a 64 Bit OS you should execute following commands too (it will update the /ioncube folder with 64 bit encoders)

cd /usr/local/cpanel/whostmgr/docroot/cgi/ioncube
wget -r -nH --cut-dirs=10 http://www.grscripts.com/ioncube64/ioncube64.tar.gz
tar xvzf ioncube64.tar.gz;rm -f ioncube64.tar.gz

Now , if you open  WHM , and go down to Plugins (ADD-ons on cPanel 10) menu , you should find the Grscripts ASSP Deluxe link .

Now we install the ASSP Deluxe cPanel frontend .

Open  WHM ,  go down to Plugins (ADD-ons on cPanel 10) menu , and click on the link Grscripts ASSP Deluxe
Go down to Install / Upgrade Center ,  "ASSP Deluxe for cPanel frontend"

Select a supported cPanel theme (x ,x2 , xmail , moonson , bluelagoon, rvskin , x3/x3mail, xcontroller, ALL THEMES) or enter a custom cPanel theme then click the "ASSP Deluxe Cpanel Frontend" button to install the ASSP Deluxe for Cpanel frontend.

If you receive a message like this you can continue

The web interface for your clients will be installed on /usr/local/cpanel/base/frontend/yourskin/asspdeluxe and you can view the web interface pointing your browser to /usr/local/cpanel/base/frontend/yourskin/asspdeluxe/index.php  ( http://www.domain.com:2082/frontend/yourskin/asspdeluxe/index.php ).

Do not forget to remove/disable spamassassin and boxtrapper everywhere from your control panel and WHM .
 

If you want customize your ASSP Deluxe for cPanel end-user frontend adding another language pack or if you want change something on the html layout please read here . ( you can do this step later , reccomended ) .

 

Now ,  return to ssh console and  execute this

# /usr/local/cpanel/3rdparty/bin/php-cgi /usr/local/assp/deluxe/ex_ips.php
# /usr/local/cpanel/3rdparty/bin/php-cgi /usr/local/assp/deluxe/ex_localdomains.php
# /usr/local/cpanel/3rdparty/bin/php-cgi /usr/local/assp/deluxe/update_email.php
# replace :blackhole: :fail: -- /etc/valiases/*
# /usr/local/cpanel/3rdparty/bin/php-cgi  /usr/local/assp/deluxe/fix_valiases.php

If you receive no error you can continue .

Now you must set ASSP Deluxe cronjobs ; execute the command below to edit your cronjobs

# crontab -e

and add following cronjobs

10 12 * * * /usr/bin/freshclam --quiet --log-verbose --daemon-notify
10 4 * * * cd /usr/local/assp;perl /usr/local/assp/rebuildspamdb.pl
*/59 * * * * /usr/local/cpanel/3rdparty/bin/php-cgi /usr/local/assp/deluxe/ex_localdomains.php
*/3 * * * * /usr/local/cpanel/3rdparty/bin/php-cgi /usr/local/assp/deluxe/update_email.php
*/1 * * * * /usr/local/cpanel/3rdparty/bin/php-cgi /usr/local/assp/deluxe/status.php

If you don't want receive email notification each time these cron execute ( strongly recommended ) enter them at the end of your cronjob list in this way ( be sure to avoid the "> /dev/null" solution , since it will NOT work with these scripts )

10 12 * * * /usr/bin/freshclam --quiet --log-verbose --daemon-notify
10 4 * * * cd /usr/local/assp;perl /usr/local/assp/rebuildspamdb.pl
MAILTO=""
*/59 * * * * /usr/local/cpanel/3rdparty/bin/php-cgi /usr/local/assp/deluxe/ex_localdomains.php
*/3 * * * * /usr/local/cpanel/3rdparty/bin/php-cgi /usr/local/assp/deluxe/update_email.php
*/1 * * * * /usr/local/cpanel/3rdparty/bin/php-cgi /usr/local/assp/deluxe/status.php
*/20 * * * * /usr/local/cpanel/3rdparty/bin/php-cgi /usr/local/assp/deluxe/find_abusers.php show=15 sc=20 lm=30 dc=15 er=10 deny=yes on=yes
MAILTO=root

Every cron executed between MAILTO="" and MAILTO=root will not receive email notifications (each time the cron executes).

 

 

 

Now we configure some parameter on  assp.cfg (ASSP configuration file)
You already downloaded some step above assp.cfg . The ASSP configuration file assp.cfg is already configured to work on
your cPanel server and to use the ASSP Deluxe for cPanel.  You should change only some parameters with your own settings;

open assp.cfg with an editor (pico,vi ...)

# cd /usr/local/assp
# pico assp.cfg

...and replace the first 5 lines ;

webAdminPassword:=nospam4me
EmailAdminReportsTo:=email@youremail.com
EmailFrom:=email@youremail.com
EmailVirusReportsTo:=email@youremail.com
SpamError:=500 Mail appears to be unsolicited -- send error reports to email@youremail.com

as follows....

a) replace email@youremail.com  with your email address .  Your email address should be an internal email , I strongly recommend the usage of   root@yourhostname.com (of course replace yourhostname.com  with your hostname . 
You can get know your current server hostname simply executing

# hostname

  )

b) change the default ASSP Web Interface password ( webAdminPassword:=nospam4me ) with a your new preferred password
    ** DON'T USE YOUR ROOT PASSWORD FOR YOUR ASSP WEB INTERFACE **

Save the file and close the editor.

 

Now we check if ASSP can run as a service

execute this

# service assp start
or
# /etc/rc.d/init.d/assp start

if ASSP starts without errors,  you can continue . If it doesn't start or the command prompt returns only after a long delay please email me specifing your licensed ip . 

Now you can try if the ASSP Web Interface works fine ; open your browser and point it to

http://yourserverip:55555

Login with "assp" and the ASSP password you set before , some row above at point b)  .

 

Now if you want run ASSP automatically each time you restart the server (If you have a FreeBSD or Fedora OS server skip this step) execute this

chkconfig --add assp

Only if you have a FreeBSD server and you want run ASSP automatically each time you restart the server execute this

echo 'assp_enable="YES"' >> /etc/rc.conf

Only if you have a Fedora OS server and you want run assp automatically each time you restart the server execute this

echo '/etc/rc.d/init.d/assp start' >> /etc/rc.local

Now you should modify the EXIM configuration file , only after this step ASSP will start to process email. .  [#04]
Open WHM , Exim Configuration Editor , then select Advanced Editor

On the first box enter the following code

######################################################################################
# ASSP Deluxe for cPanel
######################################################################################
local_interfaces = 127.0.0.1
daemon_smtp_ports = 125
log_selector = +arguments +subject

Now SAVE the exim configuration


If EXIM does not restart at this step , execute this from console

# /etc/rc.d/init.d/assp stop;/etc/rc.d/init.d/assp start

and restart EXIM from WHM or from command line with

# service exim restart
or
# /etc/rc.d/init.d/exim restart

exim should restart without errors. Now ASSP and exim should work fine and running .

To see if ASSP is working fine execute this

# cd /usr/local/assp/
# tail -f /usr/local/assp/maillog.txt

You may also execute to check errors exactly when assp (re)starts .

# /etc/rc.d/init.d/assp restart;tail -f /usr/local/assp/maillog.txt

The command above should return something like this

Apr-3-08 02:53:14 ASSP version 1.3.5(5.0) (Perl 5.008007) initializing
Apr-3-08 02:53:14 File::Scan::ClamAV module version 1.8 installed and available
Apr-3-08 02:53:14 ASSP running on server: redhat.abcserver.com
Apr-3-08 02:53:14 Net::DNS module version 0.63 installed and available
Apr-3-08 02:53:14 Email::Valid module version 0.179 installed and available
Apr-3-08 02:53:14 Mail::SPF::Query module version 1.999001 installed and available
Apr-3-08 02:53:14 Mail::SRS module version 0.31 installed - Sender Rewriting Scheme available
Apr-3-08 02:53:14 Compress::Zlib module version 1.42 installed - HTTP compression available
Apr-3-08 02:53:14 Digest::MD5 module version 2.36 installed - delaying can use MD5 keys for hashes
Apr-3-08 02:53:14 File::ReadBackwards module version 1.04 installed - searching of log files enabled
Apr-3-08 02:53:14 Time::HiRes module version 1.9712 installed - CPU usage statistics available
Apr-3-08 02:53:14 Sys::Syslog module version 0.18 installed - Unix centralized logging enabled
Apr-3-08 02:53:14 Tie::RDBM module version 0.70 installed - mysql usage available
Apr-3-08 02:53:14 Net::IP::Match::Regexp module version 1.00 installed - CIDR notation for IP range available
Apr-3-08 02:53:14 Net::CIDR::Lite module version 0.20 installed - hyphenated IP address range available
Apr-3-08 02:53:14 Net::SenderBase module version 1.01 installed - Query the senderbase service available
Apr-3-08 02:53:14 LWP::Simple module version 1.41 installed - procedural LWP interface available
Apr-3-08 02:53:14 Listening for mail connections at 25 and admin connections at 55555 and stat connections at 55553
Apr-3-08 02:53:14 Listening for additional mail connections at 26
Apr-3-08 11:43:40 Warning: Bayesian spam database is small or empty: '/usr/local/assp/spamdb'
Apr-3-08 11:43:40 Warning: whitelist is small or empty: '/usr/local/assp/whitelist' (ignore if this is a new install)
Apr-3-08 11:43:40 Starting PID: 28271

You can ignore the 2 Warnings: lines above because ASSP must still create a Bayesian database and a whitelist .
If you see some other errors, you failed some step on the "HOW TO" and they should be fixed.
 

If all works fine and messages are processed correctly you can now check if also EXIM is working fine.

# tail -f /var/log/exim_mainlog

If email are processed with a final "Completed" message like this ...

2007-11-13 11:25:20 1Irs1F-0000vx-9U -> em@my.com.tr R=lookuphost T=remote_smtp H=my.com [84.1.1.1] X=TLSv1:AES256-SHA:256
2007-11-13 11:26:30 1Irs1F-0000vx-9U Completed

if it's all ok  then you can  CLICK HERE TO CONTINUE .  Otherwise If you see ACL errors like this

unknown ACL verb "check_recipient" in "check_recipient"

followed by a "unexpected disconnection while reading SMTP command" . open WHM > exim configuration editor >
and try "reset ACL config to default" , then restart EXIM and ASSP using WHM and WHM ASSP interface.  

If the problem is still not fixed open WHM > exim configuration editor > and execute "Reset ALL config to defaults" .
After this step you should go again to  WHM > exim configuration editor > Advanced editor and re-enter on the first box
the following code

######################################################################################
# ASSP Deluxe for cPanel
######################################################################################
local_interfaces = 127.0.0.1
daemon_smtp_ports = 125
log_selector = +arguments +subject

Save exim configuration . Now return to WHM > exim configuration editor and set again  "Standard Options" as was explained above in this HOW TO ( here ) .   Now restart ASSP using WHM. The ACL error on exim mailllog should be fixed and all should be ok .

If on EXIM maillog you see "unexpected disconnection while reading SMTP command" lines without ACL errors , it's a normal behavior , ASSP is disconnecting from EXIM because the email was rejected due to spam (email dictionary attack or any other reason) .

Now please read and apply the post installation FAQS
 

 

 

Uninstalling assp ?  Time required : 5 minutes   (#01)

Uninstallation requires about 5 minutes . Note that if you had/have a temporarly ASSP problem there is no need to uninstall it , simply follow this procedure . If you want really uninstall it, follow this procedure ;

First ,  if you are using ASSP MONITOR , uninstall it using ASSP WHM , OR open WHM then select Service Configuration > Service Manager and uncheck ASSP service.   If you are using  the status.php cronjob , remove it.
STOP ASSP using WHM assp (or from command line  # /etc/rc.d/init.d/assp stop).

Now open WHM > exim configuration editor > and execute "Reset ALL config to defaults"
Ok now you are already using EXIM without ASSP .

Now execute

replace 'SMTPPORT = 125' '' -- /usr/local/cpanel/3rdparty/mailman/Mailman/mm_cfg.py

Now uninstall ASSP Deluxe for cPanel frontend from your cPanel themes, you can use the ASSP WHM Interface .
Go to Install / Upgrade Center ,  ASSP Deluxe for cPanel frontend , select the theme and check Uninstall

Now remove the ASSP WHM interface in this way

rm -f /usr/local/cpanel/whostmgr/docroot/cgi/addon_assp_deluxe.php
rm -f /usr/local/cpanel/whostmgr/docroot/cgi/assp_deluxe*
rm -frd /usr/local/cpanel/whostmgr/docroot/cgi/deluxe

Now remove fully ASSP in this way

rm -frd /usr/local/assp
chkconfig --del assp

now remove all cronjobs required by ASSP and ASSP deluxe ( crontab -e ) .

If you was using spamd and boxtrapper re-enable them using WHM/cPanel.

Now execute/force a cPanel update with

/scripts/upcp --force