Document information

Document ID: 4656
Subject: Backing up Xeams installation
Creation date: 12/14/15 4:35 PM
Last modified on: 10/21/20 11:42 AM


Backing up a Xeams installation



Every file in Xeams gets installed in the installation folder. The installation folder on Windows is typically set to C:\Xeams and is /opt/Xeams on Linux, UNIX. Therefore, if you backup this entire folder you can restore it if disaster strikes.

However, backing up the entire installation folder is more than what you need. The following table describes the purpose of each folder and leaves the decision up to the administrator if he/she wants to backup.

Folder name Purpose
AuditLogs Backing up this folder is optional. It holds logs files used to display Audit Logs in Xeams.
config This is the most important folder and holds every configuration parameter. In fact, it has another sub-folder called archives, which holds a backup of every configuration file. You should see 7 files in this folder containing a backup for every weekday.

It is recommended you backup the entire config folder

db This folder holds data that is used for reporting purposes. If this folder is missing, it will be recreated automatically provided the Reports folder is present. If both db and Reports folders are missing, reports in Xeams won't display any data.

GoodEmails This folder holds every Good email. You should backup this folder if you are using Xeams as the primary server. If you are using Xeams as a firewall, a copy of every good message already exist on your primary server. In that case, retaining these email is optional.

jre No need to backup this folder. Xeams installer will create this at the time of installation.

lib No need to backup this folder. Xeams installer will create this at the time of installation.

logs Holds logs created by Xeams. Backing up this folder is optional.
MailingListSubs You only have this folder if you are using the mailing list feature in Xeams. You don't have to backup this folder.

OutbounMailQueue Holds messages that are waiting to be delivered.

patches No need to backup this folder. Xeams installer will create this at the time of installation.

PossibleSpam Holds message that fall into Possible Junk category. If this folder is missing you won't see any email in the Message Repository for Possible Junk

ProcessingMessages No need to backup this folder. Xeams installer will create this at the time of installation.

Reports This folder, along with db folder is responsible for generating reports.

SearchIndexes Holds search index that are used by the Admin Console to search messages in Message Repository. If this folder is missing you won't be able to find older email messages in Admin Console. You should backup this folder.

SpamEmails Holds junk messages. If this is missing, you won't see any junk email in Message Repository.

UserRepository You should backup this folder. It hosts email repository for POP3 and IMAP servers.

Uninstall_Xeams
No need to backup this folder. Xeams installer will create this at the time of installation.

webfront No need to backup this folder. Xeams installer will create this at the time of installation.

Which program can I use to backup Xeams?

You can use any backup program. However, we recommend you use Syncrify.





Add a comment to this document

Do you have a helpful tip related to this document that you'd like to share with other users?

Important: This area is reserved for useful tips. Therefore, do not post questions here. Instead, use our public forums to post questions.