MailArchiva Upgrade
 

Licensing Prerequisite

 

As part of the upgrade process, depending on the validity of your support contract, it may be necessary to download and install a new license file. An issued license includes a "paid_period_end" date field. This field specifies the expiry date of the maintenance contract. This expiry date is also shown in Configuration->About. When a maintenance contract is renewed, a new license file is issued with an updated  "paid_period_end" that corresponds with the end date of the new support contract. Any version of MailArchiva whose build date does not exceed the installed license file's paid_period_end date may be used. If a version of MailArchiva is installed whose build date exceeds the installed license's paid_period_end field, the license will show as invalid. In this case, it is necessary to renew your support contract before upgrading and/or downloading and installing a new license file.  When receiving a new license file after upgrading your support contract,  please remember to install the new license file to ensure that the server can stay current.

 

Upgrade Procedures

 

 

Note: Please refer to Upgrade Issues to resolve common issues related to server upgrades.

 

Major Version Upgrades

 

Note: Be sure to read the Supplementary Major Version Upgrade Notes before proceeding with the setup.

 

Click on the appropriate highlighted upgrade version in the table below.

 

Present Version* Upgrade Version      
V1 V2 V3 V4 V5 V6 V7 V7
V2   V3 V4 V5 V6 V7 V8
V3     V4 V5 V6 V7 V8
V4       V5 V6 V7 V8
V5         V6 V7 V8
V6           V7 V8
V7             V8

*The present version of MailArchiva is displayed in Configuration->About.

 

 

Major Version Upgrade

 

  1. Download the latest version of MailArchiva from https://stimulussoft.com/downloads

 

Windows

 

  1. Stop the existing MailArchiva service from the Windows Services Applet.
  2. Run the setup script by double clicking the installer. Accept a license agreement.
  3. When prompted to enter maximum heap size, follow these guidelines. For instance, if 12GB of physical RAM is available, enter 5192m.
  4. If writing data to network shares, edit the MailArchiva Windows service using the Windows Service Manager, and set the logon account with sufficient read/write permissions.
  5. Start the MailArchiva Windows Service in the Windows Service Manager.
  6. Login to the Console by accessing http://localhost:8090 using a browser.
  7. If the upgrade occurred correctly, the setup wizard will not be displayed (since the server should have already been configured).
  8. If necessary, install the license key in Configuration->About
Linux

 

  1. Stop the server
systemctl stop mailarchiva

 

  1. Run the installer as indicated below and follow the installer prompts.
     
wget https://stimulussoft.b-cdn.net/mailarchiva_server_linux_v8.11.20.tar.gz
tar -xzvf mailarchiva_server_linux_v8.11.20.tar.gz
cd mailarchiva_dist
./install


When prompted to enter maximum heap size, follow these guidelines. For instance, if 12GB of physical RAM is available, enter 5192m.
 

  1. Start the MailArchiva service by running:
     
systemctl start mailarchiva

 

  1. Login to the Console by accessing http://localhost:8090 using a browser.
  2. If the upgrade occurs correctly, the setup wizard will not be displayed.
  3. If necessary, install the license key in Configuration->About
Note: Please refer to Upgrade Issues to resolve common issues related to server upgrades.

 

Major Version Upgrade From Legacy (OSE/V1/V2)

 

  1. Disable archiving in the existing server.

    a) In Configuration->Journal Accounts, uncheck Enabled for all connections.
    b) In Configuration->Listeners, disable SMTP and Milter listeners.
  2. Close the existing Active volume in Configuration->Volumes.

 

Windows
 

  1. Stop the MailArchiva service from Windows Services Applet.
  2. Backup C:Program Files (x86)MailArchivaServerwebappsROOTWEB-INFconf and C:Program Files (x86)MailArchivaServerwebappsROOTWEB-INFlogs directories using file explorer.
  3. Create a new volume in Configuration->Volumes.
  4. Continue by following the instructions Major Version Upgrade above.
  5.  Login to the Console. Ensure Light stemming is selected in Configuration->Index.
  6. Click Configuration->Volumes->Reindex All to reindex all volumes.

Linux

 

  1. Stop the MailArchiva server.
systemctl stop mailarchiva (Linux)

 

  1. Create a new volume in Configuration->Volumes.
  2. Continue by following the instructions in Major Version Upgrade above.
  3.  Login to the Console. Ensure Light stemming is selected in Configuration->Index.
  4. Click Configuration->Volumes->Reindex All to reindex all volumes.
 

Supplementary Major Version Upgrade Notes

 

  • Take note that the system requirements for the upgraded version may differ from that of the older release. Notably, MailArchiva V5/V6/V7 runs on 64 bit OS.
  • If you move servers and upgrade from MailArchiva V2/OSE at the same time, refer to Move Server for further instructions.
  • All major version upgrades require a valid support contract.
  • Directory locations changed from V1/V2->V3/V4-for MailArchiva's program files, configuration files, program data and logs have changed since previous versions. Please familiarize yourself with File System Layout.
  • It is a good idea to backup your server configuration before running the installer.
  •  Make sure your volume store directories are not placed anywhere under the MailArchiva program directory (e.g.  C:Program FilesMailArchiva or /usr/local/mailarchiva) as the directory will be recursively deleted during the upgrade process. Your volume stores should always reside outside the MailArchiva program directory.
  • Support for 32 bit OS has been dropped in MailArchiva V5+. Please install MailArchiva on an x64 OS. Follow Move Server instructions to move and upgrade.
Note: Please refer to Upgrade Issues to resolve common issues related to server upgrades.

 

Minor Version Updates

 

In most cases, minor version updates can be performed via the Auto Update or WAR file method. if neither of these methods work, follow the major version upgrade procedure.

 

Be sure to read the Supplementary Minor Version Upgrade Notes before proceeding with an update.

 

WAR Upgrade

 
  1. Download the WAR file.
  2. Stop the MailArchiva service.
  3. Delete the contents of [web application] (do not rename this folder under the same location!) .
  4. Rename the WAR file to ROOT.war and copy it to the contents of[web application].
  5. If upgrading from any version prior to V8.11, edit C:ProgramDataMailArchivaTomcatconfserver.xml (Windows) or /var/opt/mailarchiva/tomcat/conf/server.xml (Linux), change autoDeploy="true" and unpackWARS="true" in Host tag.
  6. Start the MailArchiva service
     
Linux WAR Upgrade Example

 

cd /root
wget https://stimulussoft.b-cdn.net/mailarchiva_v8.11.20.war -O ROOT.war
systemctl stop mailarchiva
cd /var/opt/mailarchiva/tomcat/webapps/ROOT
rm -rf *
cp /root/ROOT.war .
nano /var/opt/mailarchiva/tomcat/conf/server.xml
search for Host tag, change autoDeploy="true" and unpackWARS="true". Save.
systemctl start mailarchiva
 
 
Windows WAR Upgrade Example
 
 
Download the latest WAR file from https://stimulussoft.com and rename it to ROOT.war
Stop MailArchiva Service from Windows Service Manager
Delete the contents of C:ProgramDataMailArchivaTomcatwebapps directory
Copy ROOT.war to C:ProgramDataMailArchivaTomcatwebapps directory
If upgrading from any version prior to V8.11, edit C:ProgramDataMailArchivaTomcatconfserver.xml (Windows), change autoDeploy="true" and unpackWARS="true" in Host tag.
Start MailArchiva Service from Windows Service Manager
 
 

Auto Update

 

  1. Login to the MailArchiva console.
  2. Visit Configuration->Auto Update.
  3. Click the Update button.
     
Note:  After the update is downloaded, it may be necessary to wait a while before the update will be applied and service reloaded.

 

 

Supplementary Minor Version Upgrade Notes

 

  • A minor update does not change the app server and Java Runtime software; only the MailArchiva program code.
  • If new versions are not being shown in Configuration->Auto Update,  try performing a full major version upgrade to reinstall the auto update application.
  • On rare occasions, the Java runtime may be changed between minor versions. In such situations, a hint will be placed in the changelog and it may be necessary to perform a full major version upgrade.
Note: Please refer to Upgrade Issues to resolve common issues related to server upgrades.
Was this information helpful?

Found this information useful? Visit mailarchiva.com to learn more about MailArchiva.

The page cannot be found

The page you are looking for might have been removed, had its name changed, or is temporarily unavailable. Please make sure you spelled the page name correctly or use the search box.