concrete5 Auto Backup Server Shell Script

concrete5

I just made this concrete5 auto-backup shell script.

This is simple shell script to back up your concrete5.7.x site. This is the script that runs on your server.

MIT LICENSE and NO GUARANTEE

This script is licensed under The MIT License. USE IT AT YOUR OWN RISK.

Set-up

  1. Go to GitHub and download concrete5-backup.sh.
  2. Add your server config in concrete5-backup.sh
  3. If you don’t uncomment MYSQL_PASSWORD option, you will have to enter MySQL Password every time you run this script.
  4. Upload the concrete5-backup.sh to your server
  5. Change the file permission chmod 700 concrete5-backup.sh Or whatever the permission you need to execute the file. But make sure to minimize the permission.
  6. Run the sh file from ssh or set-up CRON job.

It’s is highly advised that you know what you’re doing with this script. You MUST have certain amount of knowledge of what shell script is.

CAUTION: Check your concrete5 folder.

This script first save the SQL dump file onto concrete5 directory. If the script fails, it may leave the SQL file under the server. MAKE SURE to check the server occasionally.

How to Run and Options

At default, you still need to enter the MySQL Password.

Format

cd path/to/shell/file
sh concrete5-backup.sh [1st option] [2nd option]

Example

cd /var/www/html
sh concrete5-backup.sh --all --relative

1st Option

1st option will determine how much file you want to backup

FILES option (default)

back up a SQL and the files in application/files

  • [no option]
  • –files
  • –file
  • -f

DATABASE option

back up only a SQL dump fule under WHERE_IS_CONCRETE5 path

  • –database
  • -d

ALL file option

back up a SQL and all files under WHERE_IS_CONCRETE5 path

  • –all
  • -a

PACKAGE option

back up a SQL, and the files in application/files, packages/

  • –packages
  • –package
  • -p

HELP option

Shows all the help options.

  • –help
  • -h

2nd option

You MUST specify 1st option if you want to specify 2nd option.

2nd option determine if you need to work as absolute path or relative path. A Mac OS User reported that they need to be specify absolute path. You may need to use the 2nd option if you’re running this as a cron job.

RELATIVE option (default)

The shell runs relative path.

  • [default]
  • -r
  • –relative

ABSOLUTE option

The shell always use absolute path when dumping and zipping files.

  • -a
  • –absolute

VARIABLES TO SET

Once you download the sh file, you must change the where VARIABLES is from line 15

NOW_TIME

Default:date "+%Y%m%d%H%M%S"

It would add current year, month, date, hour, and seconds to the backup files.

For example, if you think you don’t want to put all the minutes and second, remove %M%S.

WHERE_TO_SAVE

Enter the server full path where you want to save your backup files to.

e.g. WHERE_TO_SAVE="/var/www/html/backup"

HINT: If you don’t know where to find, use “pwd” command to find your current location of the server to find the full path of the server.

WHERE_IS_CONCRETE5

Enter the full server path of where your concrete5 site is installed

e.g. WHERE_IS_CONCRETE5="/var/www/html/concrete5"

FILE_NAME

Enter the identical file name. This will be the prefix of your file.

e.g. FILE_NAME="katzueno"

MYSQL_SERVER

Enter the MySQL server address.

e.g. MYSQL_SERVER="localhost"

MYSQL_NAME

Enter the name of your MySQL database.

e.g. MYSQL_NAME="database"

MYSQL_USER

Enter the MySQL username

e.g. MYSQL_USER="root"

MYSQL_PASSWORD (Option)

If you don’t want to enter the password every time, uncomment the MYSQL_PASSWORD and enter the MySQL password.

e.g. MYSQL_PASSWORD="root"

Version History

2.0 (December 28, 2015)

  • --single-transaction option added to MySQLdump comman (thanks Endo-san)
  • 2nd option of relative path or absolute path added for Mac OS user (thanks Endo-san)
  • database option added: option to only back-up the SQL dump file
  • Some script validation using www.shellcheck.net
  • Fix some English

1.0.1 (December 26, 2015)

  • Fix where the ALL option generates error because it was indicating the same zip location twice.

1.0 (December 26, 2015)

  • First version.

 

Download

https://github.com/katzueno/concrete5-backup-shell

Good luck