fbpx

Thanks for downloading the Gautit Backup plugin for Mautic.

Installation:

Like any Mautic plugin you will unzip the plugin.

Copy the GautitBackupBundle folder to the folder plugins, in the Mautic installation.  It will be in the root or first level of the installation.

Clear the cache folder from Mautic using the standard procedure:

The easiest is to go to the /app/cache folder and delete the /prod/ folder. If you want to do it via CLI command, navigate to the Mautic root folder and run rm -rf app/cache/prod . The new cache files will generate itself after the next Mautic refresh in the browser. or use the Mautic command line from the root directory of your Mautic installation:  app/console cache:clear

Alternatively, you can use the GautIt Cache Cleaner plugin

Now open Mautic and login.

On the dashboard click the gear icon in the top right.   This opens the configuration menu, click plugins.

Click the install/upgrade button on the plugins page.

Select the Gautit Backup plugin by clicking on it.

 

Then select yes under Published to make the plugin active.   Enter your license key to enable extra features such as timed backups, and remote backup storage.  Don’t have a license key?  Click here to get yours now!

Installation is now complete.

Using the plugin:

Now a new menu item is on the settings menu (the little gear icon in the top right)

Clicking the menu item will get you into the Gautit Backup page.

Here, you can enter a name for your backup, something like “before plugin install”, or “before import”.   If you have the free version, backup local is your only option, if you have a license see below for instructions on setting up your remote drive.

Click Backup Now and your backup will start immediately.  Log messages will be shown on the screen.  Three files are created for each backup, the Mautic directory and files, the mysql dump and a log file.

You can click on the buttons, file, database or log to download the files to your computer.  If you don’t have a license, the files are backed up to your server into a folder in the cache directory.

Backups will NOT backup previous backups.  This is to keep file storage down.

Use the left drop down to delete a backup set.  Deleting will remove all three files for that backup set.

Licensed Edition

If you have purchased a licensed edition, you have additional features that you can utilize.  Primarily the ability to store your backups in real-time on remote storage.

The Gautit Backup page, has a an extra tab, and some extra check boxes.

To use the remote storage, a few steps need to be completed to enable this process.

Click on the settings tab.  You will see options for remote storage.

Select the remote drive space you would like to configure on the left.

Amazon S3

To setup Amazon S3, you will need to configure S3 and get a Amazon S3 Key,Amazon S3 Secret and a Amazon S3 Bucket Name.

Each of these will need to be collected from Amazon S3 buckets console.  Below are screen shots of the process as of 5/2020, apologies if the process has changed, but if you notice a change let us know and we will update this.

Create Bucket in your Amazon S3 account.

https://s3.console.aws.amazon.com/s3/home

Click the Create Bucket button.

On the next page, perform the following steps:

  1. Use Gautit Bucket as the bucket name.  If you backing up multiple Mautic instances to the same S3 account, give each a unique name.
  2. Leave Block all public access checked.  Unless you know why you wouldn’t.
  3. Click Create Bucket.

Now that you have a bucket, you will need your keys.

Go to https://console.aws.amazon.com/iam/home?#home

Follow these steps:

  1. From the navigation menu, click Users.
  2. Select your IAM user name.
  3. Click User Actions, and then click Manage Access Keys.
  4. Click Create Access Key.
  5. Your keys will look something like this:
    • Access key ID example: AKIAIOSFODNN7EXAMPLE
    • Secret access key example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
  6. Click Download Credentials, and store the keys in a secure location.

Return to Mautic Backup settings page.  Enter your keys and bucket name into the settings for Amazon S3.

Click save.

Now, when performing a backup, you can check the Amazon S3 location and your backup will be saved to the bucket you setup on Amazon S3.

Dropbox

To setup Dropbox, you will need to configure Dropbox and get a Dropbox App Key, Dropbox App Secret and a Dropbox Access Token.

Each of these will need to be collected from Dropbox.  Below are screen shots of the process as of 5/2020, apologies if the process has changed, but if you notice a change let us know and we will update this.

Create Dropbox app in your account.

https://www.dropbox.com/developers/apps/create

On this page complete the following steps:

  1. Select Dropbox API
  2. For Access we recommend App folder, but Full Dropbox will work as well
  3. App name is Gautit Backup
  4. Choose your account, if you don’t have a personal and business account, you may not see this option
  5. Click the Create app button

You will then be shown a page with your app settings.   You need the App Key, App Secret (click the show link to see it), and then you will click the Generate button to get your Access token.

Now go back to the Mautic Backup Settings page.  These values from Dropbox will be entered into the corresponding fields.

Click save.

Now, when performing a backup, you can check the Dropbox location and your backup will be saved to the /Apps/Gautit Backup folder on your Dropbox.

Google Drive

Sorry, we are not supporting Google Drive (yet).  It will be in a future release.

One Drive

Sorry, we are not supporting One Drive (yet).  It will be in a future release.

Please place comments and questions below and we will respond to them as quickly as possible.