MagicSpam Installation Guide

Moderators: wizard, magicspam

Post Reply
magicspam
Posts: 1470
Joined: Tue Oct 28, 2008 2:27 pm

MagicSpam Installation Guide

Post by magicspam » Tue Apr 26, 2022 12:14 pm

Overview

MagicSpam can be installed through either the Automatic Installation process which utilizes the One-Command Installation method or the Manual Installation process which consists of the Download and Install steps. Regardless of the method of installation, the license key needs be registered through the Registration Process.

The Automatic Installation process is the recommended method to install MagicSpam as it automatically detects the web panel, operating system and architecture of the server before installing the appropriate MagicSpam product based on the license key and detected server information.

In this guide, you will learn how to install MagicSpam on your server and register your license key, including the following information:
  • Prerequisites
  • Automatic Installation
  • Manual Installation
  • Registration Process

Note

This guide is applicable to all MagicSpam products as the installation process is the same across all LITE, PLUS and PRO versions.
Prerequisites

Before starting, make sure to have the following at hand:
  • information on the web panel, operating system and architecture of the server
  • access to the command line terminal as root user on the server
  • a valid MagicSpam license key

Automatic Installation

Alert

The MagicSpam One-Command Installation method is not currently available on Windows servers, please follow the Manual Installation process to install MagicSpam for MailEnable.
The Automatic Installation process utilizes the One-Command Installation method which allows you to download and install MagicSpam using a single command at the terminal. Simply run the following terminal command as the root user on the web panel / email server, replacing the <license key> placeholder with your valid MagicSpam license key.

Code: Select all

bash <(wget -qO- https://www.magicspam.com/download/magicspam-installer.sh) -l <license key>
The command will download and run the installer script which automatically detects the web panel, operating system and architecture of the server before installing the appropriate MagicSpam product based on the license key and detected server information. Once completed, similar output will be shown in the terminal:
Running MagicSpam Installer Script 1
Validating command line arguments and system
Downloading the MagicSpam installation package for <web panel> on <operating system>
Installing the MagicSpam installation package <path to MagicSpam package>
+-------------------------------------------------------------------------------+
<server specific installation output>
+-------------------------------------------------------------------------------+
Completed MagicSpam Installation

Note

For more information on One-Command Installation method and troubleshooting guides, please refer to the MagicSpam One-Command Installation Guide.
At this point, MagicSpam is installed on your server and you can proceed to the Registration Process.

Manual Installation

The Manual Installation process consists of the Download and Install steps.

Download

The objective of the Download step is to obtain and transfer the MagicSpam installation package to your web panel / email server. The first step is to download the appropriate MagicSpam installation package by entering your license key in our Downloads Site.

magicspam_download_site.png
magicspam_download_site.png (87.28 KiB) Viewed 659 times

Carefully select the Operating System and Architecture (32/64 bit) that matches your system. If you don’t know which one to choose, please contact your hosting provider or system administrator to be certain, otherwise there may be unknown and possibly service affecting consequences.

download_site_operating_system_selection.png
download_site_operating_system_selection.png (18.32 KiB) Viewed 659 times

If you did not directly download the MagicSpam installation package to your web panel server, then the next step is to transfer the previously downloaded MagicSpam installation package to your remote web panel / email server. Simply run the following terminal command as the root user on the local server, replacing the <path to MagicSpam package>, <user>, and <server> placeholders with the path to the installation package, the remote user, and server IP address respectively.

Code: Select all

scp <path to MagicSpam package> <user>@<server>:

Note

For more information on the SCP command, please refer to this guide on How to Transfer MagicSpam Installation Package to Remote Server Using SCP.
Install

The objective of the Install step is to install MagicSpam on your web panel / email server using the installation package.

Please follow the instructions for your specific web panel.

Note

If you are upgrading MagicSpam, remove the previously installed version by running the following terminal command as the root user.

Code: Select all

rpm -e magicspam-cpanel
Open a terminal session as the root user on the cPanel server and run the following command, replacing the <path to MagicSpam package> placeholder with the path to the installation package.

Code: Select all

rpm -i <path to MagicSpam package> 
Allow a few moments for the installation to complete. Once completed, similar output will be shown in the terminal:
================================
Installation complete! Your next
step is to point a web browser to
your WHM interface and launch
Plugins / MagicSpam to configure!

Both the Plesk Administrative Interface and Command Line can be used to install MagicSpam on a Plesk server.

Plesk Administrative Interface

Note

If you are upgrading MagicSpam, navigate through the following path to remove the existing installation.
Plesk Admin Panel >> Extensions >> My Extensions >> MagicSpam >> More >> Remove
plesk_admin_panel_remove_magicspam.png
plesk_admin_panel_remove_magicspam.png (81.72 KiB) Viewed 659 times
Log into your Plesk administrative interface and navigate to 'My Extensions'.
Plesk Admin Panel >> Extensions >> My Extensions
plesk_admin_panel_extensions.png
plesk_admin_panel_extensions.png (43.9 KiB) Viewed 658 times

Install MagicSpam by clicking on the ‘Upload Extension’ button and upload the previously downloaded MagicSpam installation package. Please note that as of Plesk version 17.x, the ‘Upload Extension’ button is not available unless you add the following configuration lines to the /usr/local/psa/admin/conf/panel.ini file.

Code: Select all

[ext-catalog]
extensionUpload = true
Command Line

Note

If you are upgrading MagicSpam, remove the previously installed version by running the following terminal command as the root user.

Code: Select all

plesk bin extension --uninstall magicspam
Open a terminal session as the root user on the Plesk server and run the following command, replacing the <path to MagicSpam package> placeholder with the path to the installation package.

Code: Select all

 plesk bin extension --install <path to MagicSpam package> 

Note

If you are upgrading MagicSpam, remove the previously installed version by running one of the following terminal commands as the root user.

Code: Select all

rpm -e magicspam-directadmin
dpkg -r magicspam-directadmin
Open a terminal session as the root user on the DirectAdmin server and run one of the following commands, replacing the <path to MagicSpam package> placeholder with the path to the installation package.

Code: Select all

rpm -i <path to MagicSpam RPM package> 
dpkg -i <path to MagicSpam DEB package>
Allow a few moments for the installation to complete. Once completed, the following output will be shown at the terminal:
================================
Installation complete! Your next
step is to point a web browser to
your DirectAdmin interface and launch
Plugins / MagicSpam to configure!

Double click on the MagicSpam installation file to start the installation process.

mailenable_setup_wizard.png
mailenable_setup_wizard.png (38.71 KiB) Viewed 657 times

Click 'Next'.

mailenable_magicspam_license_agreement.png
mailenable_magicspam_license_agreement.png (16.64 KiB) Viewed 657 times

Carefully read the terms of the license agreement, click on the checkbox next to 'I accept the terms of the License Agreement', and click on 'Install'.

mailenable_setup_wizard_complete.png
mailenable_setup_wizard_complete.png (35.42 KiB) Viewed 657 times

Once the installation is complete, click on 'Finish'.

Note

If you are upgrading MagicSpam, remove the previously installed version by running the following terminal command as the root user.

Code: Select all

rpm -e magicspam-interworx
Open a terminal session as the root user on the InterWorx server and run the following command, replacing the <path to MagicSpam package> placeholder with the path to the installation package.

Code: Select all

rpm -i <path to MagicSpam package> 
Allow a few moments for the installation to complete. Once completed, the following output will be shown at the terminal:
================================
Installation complete! Your next
step is to point a web browser to
your NodeWorx interface and launch
Plugins / MagicSpam to configure!

Note

If you are upgrading MagicSpam, remove the previously installed version by running one of the following terminal commands as the root user.

Code: Select all

rpm -e magicspam-zimbra
dpkg -r magicspam-zimbra
Open a terminal session as the root user on the Zimbra server and run one of the following commands, replacing the <path to MagicSpam package> placeholder with the path to the installation package.

Code: Select all

rpm -i <path to MagicSpam RPM package> 
dpkg -i <path to MagicSpam DEB package>
Allow a few moments for the installation to complete. Once completed, the following output will be shown at the terminal:
==============================================
Installation complete! Your next step is to
access MagicSpam in the Zimbra Admin Console:

https://<server ip>:7071 (Admin Console >> Configure >> MagicSpam)

or alternatively you can a point web browser to:

https://<server ip>:6244

to configure and enable MagicSpam!

Open a terminal session as the root user on the Postfix server and run one of the following commands, replacing the <path to MagicSpam package> placeholder with the path to the installation package.

Code: Select all

rpm -i <path to MagicSpam RPM package> 
dpkg -i <path to MagicSpam DEB package>
Allow a few moments for the installation to complete. Once completed, the following output will be shown at the terminal:
================================
Installation complete! Your next
step is to point a web browser to:
https://<serverip>:6244
to configure and enable!

Registration

At this stage, MagicSpam is installed on the server but is yet to be enabled. Please follow the instructions for your specific web panel to access the MagicSpam Administrative Interface.


MagicSpam can be accessed through WHM Administrative Interface (https://<serverip>:2087) in the 'Plugins' section.

whm_panel_plugins.png
whm_panel_plugins.png (28.8 KiB) Viewed 656 times

MagicSpam can be accessed through Plesk Administrative Interface (https://<serverip>:8880). Navigate to 'My Extensions' in the 'Extensions' section.

plesk_admin_panel_extensions_magicspam.png
plesk_admin_panel_extensions_magicspam.png (51.79 KiB) Viewed 655 times

MagicSpam can be accessed through DirectAdmin Administrative Interface (https://<serverip>:2222) in the 'Extra Features' section at the Admin Access Level.

directadmin_admin_panel_admin_level.png
directadmin_admin_panel_admin_level.png (145.76 KiB) Viewed 654 times

Open up your Internet browser to your server IP address at port 6244. (https://<serverip>:6244)

mailenable_welcome_to_magicspam.png
mailenable_welcome_to_magicspam.png (45.28 KiB) Viewed 653 times

At this stage MagicSpam will ask you to set an admin password. After you type and confirm your password, click on 'Save'.

mailenable_password_saved.png
mailenable_password_saved.png (64.63 KiB) Viewed 653 times

MagicSpam can be accessed through NodeWorx Administrative Interface (https://<serverip>:2443).

nodeworx_admin_panel.png
nodeworx_admin_panel.png (44.31 KiB) Viewed 651 times

Open up your Internet browser to your server IP address at port 6244. (https://<serverip>:6244)

zimbra_welcome_to_magicspam.png
zimbra_welcome_to_magicspam.png (45.28 KiB) Viewed 645 times

At this stage MagicSpam will ask you to set an admin password. After you type and confirm your password, click on 'Save'.

zimbra_password_saved.png
zimbra_password_saved.png (64.63 KiB) Viewed 645 times

Open up your Internet browser to your server IP address at port 6244. (https://<serverip>:6244)

postfix_welcome_to_magicspam.png
postfix_welcome_to_magicspam.png (46.35 KiB) Viewed 644 times

At this stage MagicSpam will ask you to set an admin password. After you type and confirm your password, click on 'Save'.

postfix_password_saved.png
postfix_password_saved.png (65.54 KiB) Viewed 644 times

The next step is to register your license key through the MagicSpam Administrative interface, simply enter your license key and register by clicking 'Save' to enable the MagicSpam anti-spam protection.

magicspam_interface_status_disabled.png
magicspam_interface_status_disabled.png (64.55 KiB) Viewed 642 times

An information window will pop up, take a moment to read it through and exit when ready.

magicspam_interface_status_enabled.png
magicspam_interface_status_enabled.png (141.58 KiB) Viewed 641 times

Lastly make sure to set your 'Administration Email Address' in the 'Options' section below the license key registration.

magicspam_admin_email_address.png
magicspam_admin_email_address.png (100.83 KiB) Viewed 642 times

This email address will only be contacted for critical situations such as errors in processing spam definition updates, license updates, or any other conditions
found that could cause MagicSpam to become inoperable. The package itself will attempt to auto fill this information based on the server administrator email, but simply enter the new address and click 'Save' if you need to change this to a different address,

Installation Completed!

MagicSpam is now installed and registered on your server and likely already protecting your customers from spam through our recommended default server policies and IP reputation rules. We recommend taking the time to click through the MagicSpam interface to tour the available features and options.

Lastly, check out the following forum posts on various MagicSpam features: Don't hesitate to contact us if you require further assistance with your MagicSpam installation.


Last bumped by magicspam on Tue Apr 26, 2022 12:14 pm.
-- MagicSpam Support Team --

Post Reply

Return to “Features Discussion and Guides”

Who is online

Users browsing this forum: No registered users and 1 guest