Files and Database Backup
page last edited on 14 March 2018
With X-Cart the store administrator can back up the store database in a few easy steps directly from the Admin area.
In case any 3rd party or custom add-ons data is stored elsewhere but not in the X-Cart database the corresponding data won’t be included into the database backup done with the standard X-Cart utilities.
Hence there can be cases that you have to back up the database manually so that the dump includes all possible store data. For this purpose you can use any adequate facility, including different client implementations of the SSH protocol like OpenSSH or PuTTY, Telnet, phpMyAdmin, MySQL console, control panel of your hosting account, Remote Desktop client and other.
- Backing up the database through X-Cart Admin area
- Backing up the database using terminal access
- Backing up Store Files
- Backup Master Addon
Backing up the database through X-Cart Admin area
To back up the database through the X-Cart Admin area:
- Log in to the Admin area.
- Open the ‘Database Backup’ tab in the System tools -> Database section.
- In the ‘Database backup’ tab choose the option that suits you better and click on it.
If you do not have access to your server/hosting account through FTP, SSH or other suitable facility, do not select the check box and save the SQL file directly to your local computer.
Backing up the database using terminal access
To back up the database using terminal access to the server:
Log in to your server or hosting account.
Go to the X-Cart root directory.
Run the following shell command.
mysqldump -h<db_host> -u<username> -p<password> -r<backup_filename> <db_name>
The abbreviations in the command mean:
|db_host||The DNS name or the IP-address of your MySQL server.|
|username||The username for your MySQL user account.|
|password||The password for your MySQL user account.|
|backup_filename||The name and the path to the newly created SQL file with the database dump.|
|db_name||The name of the MySQL database that you use for X-Cart.|
After you have run the command, the system will generate an SQL file and save it to the directory that you have specified in the
If necessary, you can use a different path, but it is yet recommended that it be a location within the X-Cart root directory.
Backing up Store Files
Creating a backup copy of the store files presumes that you pack all the files in the X-Cart root directory into an archive and then copy or move the archive to a new location on the remote server or your local computer.
If you have previously saved the database dump into the file in the X-Cart root directory, the file will also be included into the archive.
To create an archive you need to use a file archive manager. The exact choice of the archive manager will depend on the operating system you use. On a UNIX-based server, the most popular archive manager, which is currently installed on the majority of servers, is TAR. Later in this section you will find an example of how to archive the X-Cart files with the TAR archive manager. On a Windows-based server, you can create the archive with one of the available file archive managers for Windows, including WinRAR, WinZIP, PKZip and 7Zip. You need to pack the whole X-Cart root directory to an archive and then save the archive to the directory that is parent to the X-Cart root directory.
Alternatively, if it is not possible to pack the X-Cart files into an archive directly on your server, you can copy the X-Cart root directory to your local computer or another remote server using FTP or other suitable facility. Before that, make sure the new location, to which you are planning to copy the X-Cart root directory, has enough free disk space. Besides, the control panel of your hosting provider may offer its own facilities for backing up your account data.
Backing up store files with the TAR archive manager (UNIX-based servers only)
In UNIX-based systems, TAR is known to be one of the most reliable and trustworthy utilities for creating and manipulating file archives. It is now commonly used in tandem with external compression utilities like GZIP, BZIP2 or LZMA, which enables you not only to create an archive, but also compress the data in the archive. As a result, with TAR you can create a lightweight archive of your store and then restore it using the same utility. To find out whether TAR is installed on your server, run the following shell command.
If TAR is installed on your server, the system will display a message with the version of the utility; otherwise you will see an error message. In case of the latter, please contact your hosting team for help.
To back up files with the TAR archive manager:
Log in to your server or your hosting account.
Go to the X-Cart root directory.
In the X-Cart root directory run the following shell command.
tar -czvf ../store_backup.tgz *
After you have run the command, TAR will pack all the files in the X-Cart root directory to the file store_backup.tgz and compress it with the ZIP data compression algorithm. The file will be saved to the directory that is parent to the X-Cart root directory. For example, if the X-Cart root directory is u/user/public_html/xcart, the file store_backup.tgz will be saved to directory u/user/public_html.
Backup Master Addon
To make the process of creating a full store backup more convenient and straighforward you can use a special Backup Master addon that facilitates both a database and a full store files backup in one click.
To install the addon, go to the My addons section of the Admin area and follow the procedure described in Activating and Deactivating Addons. Once the addon has been installed, open the addon settings page to configure the backup method.
You can choose one of the following methods:
- ZipArchive class biult into PHP
- Linux Shell commands
- Linux Shell commands (without compression)
Using Linux Shell commands is much faster, so it is the recommended option for Linux servers. ZipArchive class may fail when working with large backup files, but it is the only option available on Windows servers, unfortunately.
A predefined backup method is Linux Shell commands. If you change it, do not forget to Submit the changes.
To make a full store backup using the Backup Master addon go to the System tool -> Backup section and click a ‘Create backup’ button.
The addon will create a full cart backup and will list it in a history of backups where you can see a path to the backup file to use it further, the file size and date of creation. To delete a backup click the Trash icon next to it.
Help make this document better
This guide, as well as the rest of our docs, are open-source and available on GitHub.