Skip to content

Latest commit

 

History

History
175 lines (98 loc) · 3.75 KB

README.md

File metadata and controls

175 lines (98 loc) · 3.75 KB
Raw

Mautic backup shell:

This is simple shell script to back up your Mautic. Since you're using GitHub, I assume you know what you're doing. 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

You need to have the server that allows to run the shell script.

  1. Add your server config in mautic-backup.sh
  2. If you don't uncomment MYSQL_PASSWORD option, you will have to enter MySQL Password every time you run this script.
  3. Upload the mautic-backup.sh to your server
  4. Change the file permission chmod 700 mautic-backup.sh Or whatever the permission you need to execute the file. But make sure to minimize the permission.
  5. 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 mautic folder.

This script first save the SQL dump file onto mautic 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 mautic-backup.sh [1st option] [2nd option]

Example

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

1st Option

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

ALL file option (default)

back up a SQL and all files under WHERE_IS_MAUTIC path

  • --all
  • -a

DATABASE option

back up only a SQL dump file under WHERE_IS_MAUTIC path

  • --database
  • -d

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_MAUTIC

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

e.g. WHERE_IS_MAUTIC="/var/www/html/mautic"

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"

Future Plan

  • Support of TAR
    • (Actually, you could uncomment line 142 and 150 and comment-out line 143 and 151, if you want tar now.)

Version History

0.1a (October 28, 2016)

  • First version.

Contact

http://katzueno.com/

Please feel free to create an issue or send me a pull request. Your feedback is always welcome!