OnApp provides the ready-to-use tool for database backing up - /onapp/onapp-cp-install/onapp-database-dump.sh. This tool is a part of onapp-cp-install package, so it is mandatory for every Control Panel. It is configured as a cron job to dump OnApp database regularly. Also, this tool is used by the CP installer (onapp-cp-install.sh) to dump the OnApp database before any upgrade.
On this page:
To set dumping properties, the tool reads the following configuration files:
specifies MySQL/MariaDB connection properties, like:
|specifies whether SSH File Transfer Server is used: |
When to run?
The tool is configured as cron job to run hourly. This could be customized in
DB_DUMP_CRON variable (
- The default value is "40 * * * * "
- Set any other crontab-styled value or leave it blank to disable the job.
- Pass the "-D" option to the CP installer (
onapp-cp-install-sh). This will:
disable database dumping during CP install/upgrade;
make sure that dumping is disabled in the cron;
make sure no cron job is running during install/upgrade.
How many copies to store?
The number of stored dumps is configured by
KEEP_DUMPS variable. The default value is "168" (store 24 dumps per day, and keep for a last week).
Where to store dumps?
The dumps are temporarily stored on the Control Panel server in the
/onapp/interface/$ONAPP_DB_DUMP_ROOT directory. The directory
/onapp/interface/db/dumpis set by default. The
ONAPP_DB_DUMP_ROOT variable value could be changed in the
- SSH File Transfer Server if enabled in the OnApp configuration. The backups will be moved into server's
backups_pathdirectory and rotated there. The dumps are removed from CP box if transfer to remote box is successful.
- Any custom box. It could be configured via
/onapp/onapp-cp.conf.The backups will be moved into server's DB_DUMP_SERVER_ROOT directory and rotated there. The dumps are removed from CP box if transfer to remote box is successful.
The custom box should be accessible via ssh from the CP box using
onapp user without specifying the password.
What is the backup file?
Starting from OnApp version 6.5 Edge 1, the database dump file is named like:
1611071664.localhost.onapp.sql.gz.tar is tar tape archive.
The tar tape archive includes:
GNU zip archive of SQL (the actual dump). For example,
|YAML structured file with the key to encrypt some of the data. The file should be restored from the appropriate backup in |
To backup the entire OnApp database, use the Linux
To backup a standalone table, use the following syntax replacing
table_name with the name of the table to be backed up:
To find the required MySQL password, use the following command: