xqual/xstudio-backup repository overview

⁠Goal

This Docker image runs the backup operations of the database (operated by the xqual/xstudio-mariadb image). The daily backups are create at 2am local time and stored locally in the /home/backup folder. The weekly transfer to a third-party FTP server is executed at 3am local time (if configured).

⁠Tag

The tag (i.e. "v1") just represents the version of the image and has no compatibility constraint with the other images.

⁠Parameters

The docker needs a few parameters to be customized with your own preferences:

As you can see, this docker image can take optional parameters which are used only if you wish to transfer the latest backup once a week on a third-party FTP server.

⁠Example

Based on the above example values, the image can be run in a container using the command:

docker run --name xstudio-backup-container
-e MYSQL_DATABASE=xstudio_db
-e MYSQL_USER=xstudio
-e MYSQL_PASSWORD=xstudiopwd
-e BACKUP_FTP_HOST=ftp-server.acme.com
-e BACKUP_FTP_USER=ftpuser
-e BACKUP_FTP_PASSWORD=ftpuserpwd
-e CUSTOMER_INSTANCE_NAME=acme_prod_1
xqual/xstudio-backup:v1

Thanks to the optional parameters, once a week, the latest recorded backup will be transfered to the FTP server ftp-server.acme.com (connecting as ftpuser with password ftpuserpwd) in the root folder acme_prod_1

⁠Docker-compose

It is not really useful to run this container by itself though. You should use Docker-compose to run it as part as an integrated instance. More details here: https://www.xqual.com/documentation/install/install_xstudio_docker.html⁠