This document explains how to back up H-Sphere system and user data
with the help of H-Sphere backup script.
Currently, the script updates only servers running the Control Panel and
the Postgres system database.
It requires postgresql client version 7.3 or higher installed and the psql
program available in the system paths on the CP server.
We recommend that you set up a separate server to store backup archives.
Each H-Sphere server has a copy of the backup script located in the
/hsphere/shared/backup directory. The script includes the following files:
hs_bck - the main script file;
hs_bck.cfg - the custom configuration file. This is the file to store
the list of directories to back up.
hs_bck.cfg.org - the default configuration file. It can be overwritten
with H-Sphere updates. This is where you can find the updated list of parameters
to the hs_bck script if it changes in the new version.
hs_bck.txt - description/readme file.
Depending on the server, you need to configure the script by editing the
To back up an individual server:
- Log into the server as root:
- cd into the backup script directory:
- Make sure the files hs_bck.cfg and hs_bck.cfg.org are identical
in what is not your custom settings. The format of the hs_bck.cfg.org file
may change with H-Sphere updates, and it is important to ensure that the backup script is
launched with correct parameters.
- In hs_bck.cfg, edit the list of directories and databases to back up. See the
backup and recovery list for each type of server.
- In hs_bck.cfg, edit the the backup storage directory, the number of latest backups
to be stored (7 by default), the log file, etc.
- For regular automatic backups, add the execution of the hs_bck file
into the CP server crontab configuration:
<TIME> /hsphere/shared/backup/hs_bck hs_bck.cfg 2>&1 > /dev/null
For example, to run the backup script every day at 6:13 AM, add the following line:
13 6 * * * /hsphere/shared/backup/hs_bck /hsphere/shared/backup/hs_bck.cfg 2>&1 > /dev/null
For additional parameters to this script, please run: