Read More
Read More
Menu Close

    Akeneo Backup Management

    Akeneo Backup Management: This module allows the store owner to take the backup of the database and assets and restore the backup files for the website. The store owner can create a backup of two types namely – Assets Backup and Database Backup. Thus, using the assets backup the store owner can create a backup for media files, PDFs, docs, etc. Also, the database backup allows the backup of product information, customer information, etc.

    Check a brief overview of the plugin –

    7JAPzfMo_Go

    Basic Requirements:

    • This module works with Akeneo 3.0.x, 3.1.x, 3.2.x, 4.0.x,5.0.x and 6.0.x. Download Akeneo from here
    • Node and Yarn packages need to be installed.
    • Also, the module is compatible with the Akeneo community and Enterprise(Flexibility) edition.
    • In case, you want to use this extension on Akeneo EE Serenity mode, please contact us.
    • For the Akeneo installation, your Akeneo server should meet these system requirements.

    Features

    • The module is compatible with Akeneo version 6.
    • Here, the services are changed to fetch data from .env file/ parameter.yml file according to the Akeneo version.
    • Create a backup profile and take a backup of the database and assets.
    • Also, track the backup process.
    • Moreover, add a backup in cron job by using Akeneo Cron Scheduler.
    • And, restore old backup (database, assets).

    Module Installation for Version 6.0.x

     1- Composer Installation

    Read This Blog

    Before beginning the composer installation

    1: Get the ACCESS KEYS [Create a support ticket]

    Searching for an experienced
    Akeneo Company ?
    Read More

    2: In Akeneo composer.json, add our repository and the installation script.

    For Akeneo 6

    {	
      "scripts": {	
            "post-update-cmd": [	
               "vendor/webkul/backupmanagementbundle/src/Webkul/BackupManagementBundle/install/config.sh COMPOSER=true NO_DOCKER=true"	
            ],	
            "post-install-cmd": [	
               "vendor/webkul/backupmanagementbundle/src/Webkul/BackupManagementBundle/install/config.sh COMPOSER=true NO_DOCKER=true"	
            ],	
            "post-create-project-cmd": [	
              "vendor/webkul/backupmanagementbundle/src/Webkul/BackupManagementBundle/install/config.sh COMPOSER=true NO_DOCKER=true"	
           ]	
       },	
      "repositories": [{	
        "type": "composer",	
        "url": "https://akeneorepo.webkul.com/"	
      }]	
    }	
    

    For Akeneo <=5.x 

    {
      "scripts": {
            "post-update-cmd": [
               
    "vendor/webkul/backupmanagementbundle/composer_install.sh"
            ],
            "post-install-cmd": [
               
    "vendor/webkul/backupmanagementbundle/composer_install.sh"
            ],
            "post-create-project-cmd": [
             
    "vendor/webkul/backupmanagementbundle/composer_install.sh"
           ]
       },
      "repositories": [{
        "type": "composer",
        "url": "https://akeneorepo.webkul.com/"
      }]
    }

    3: Use composer to install the extension

             composer require webkul/backupmanagementbundle
    

    4: Complete the authentication form.
    5: Send a Message of Success
    6: Delete your browser’s cache.

    Installing Module for Version 6.x

    •  After unzipping the appropriate extension zip, merge the “src” folder into the akeneo project.
    • From the PIM directory, run the following command over the NO-DOCKER Instance.
    ./src/Webkul/BackupManagementBundle/install/config.sh COMPOSER=false NO_DOCKER=true
    • After that run the command below over the PIM directory’s DOCKER instance.
    ./src/Webkul/BackupManagementBundle/install/config.sh COMPOSER=false NO_DOCKER=false

    Module Installation for Akeneo Version 4.x to 5.x

    Please follow the below steps for installing the Akeneo Backup Management module in your Akeneo PIM platform.

    1 – Unzip the respective extension zip then merge the “src” folder into the Akeneo project root directory.

    src

    2 – Then goto config/Bundles.php and add a line:

    Webkul\BackupManagementBundle\BackupManagementBundle::class => ['all' => true],

    In return Array.

    3 – Copy the “config” folder into the akeneo project root directory for routing.

    src-magento-2-1-1-2-

    4 – Run the following command after ssh to your akeneo server by terminal:

    For non-docker instances:

    rm -rf var/cache/ && php bin/console BackupManagement:setup:install

    And For docker instances:

    For Akeneo 5

    alias docker_php='docker-compose run -u www-data --rm php php';
    alias docker_yarn='docker-compose run -u node --rm node yarn';
    docker_php bin/console cache:clear --env=prod;
    docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
    docker_php bin/console d:s:u --force;
    docker_yarn run webpack;
    docker_yarn run update-extensions;
    docker_yarn run less;

    For Akeneo 4

    alias docker_php='docker-compose run -u www-data --rm php php';
    alias docker_yarn='docker-compose run -u node --rm node yarn';
    docker_php bin/console cache:clear --env=prod;
    docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
    docker_php bin/console d:s:u --force;
    docker_yarn run webpack;
    docker_yarn run less;

    5. If you are using PHP-fpm. Then you need to restart the PHP-fpm services and apache web server.

    For Akeneo 5

    sudo service php-fpm7.4 restart

    For Akeneo 4

    sudo service php-fpm7.3 restart

    Module Installation For Akeneo Version 3.x.

    Please follow the below steps for installing the Akeneo Backup Management Connector module in your Akeneo PIM platform.

    • Unzip the respective extension zip then merge the “src” folder into the Akeneo project root directory.
    backup

    Goto app/AppKernel.php then add the following line in function registerProjectBundles()

     new Webkul\BackupManagementBundle\BackupManagementBundle(),
    new-kernalapp

    Goto app/config/routing.yml then add these lines at top of the file

    backup_management_bundle:
        resource: '@BackupManagementBundle/Resources/config/routing.yml'
        prefix: /
    routing-yml-png-700×160-

    You have to navigate first to Akeneo installation directory (Ex: cd /opt/bitnami/apps/akeneo/htdocs). After SSH, you have to run the following command to your Akeneo server by the terminal.

    rm -rf var/cache/ && php bin/console BackupManagement:setup:install

    If you are using PHP-fpm. Then you need to restart the PHP-fpm services and apache web server.

    sudo service php-fpm7.2 restart

    Common Issues After Installation

    It might happen that even after proper installation, upon opening your Akeneo admin dashboard, you see a loading screen. In that case, do check for the following solution:

    • Webpack Installation: If you get the below error

    It means that a web pack is not installed in your system. Run the following command

    npm install --save-prod webpack npm install
    • Module routing.yml is not configured properly. Re-check the routing.yml file as mentioned in the 3rd step of Module Installation
    • Clear your browser cache.

    Uninstall Module: For Akeneo 6

    • From the PIM directory, run the command below over the NO-DOCKER Instance.
    ./src/Webkul/BackupManagementBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true
    • Run the command below over the PIM directory’s DOCKER instance.
    ./src/Webkul/BackupManagementBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false

    Workflow

    After successfully installing the module in Akeneo, you will see the “Akeneo Backup Management” icon in Akeneo from the bottom left as shown below.

    Dashboard-8

    With the help of this module, you can do two things:

    • Backup Configuration:- In this, you can take the backup of the database and assets.
    • Restore Backup:- In this, you can restore old backup files like the database and assets.

    Backup Configuration

    Admin can configure database backup by navigating to Backup >> Backup Configuration.

    Then you can add a new backup by clicking on New Backup.

    Akeneo-Backup-Management

    After that add the backup code after that click on the Save button.

    Akeneo-Backup-Management-1

    Then after clicking on the save button, it will redirect to the new page where you need to select the backup, backup code, backup type(database, assets), and enter the internal path.

    Edit-Backup-Details

    After that click on the Save button. Then click on the Execute button.

    Akeneo-Backup-Management-2

    Restore Backup

    Admin can restore the backup by navigating to Backup>>Restore Backup.

    Akeneo-Backup-Management-4

    After that click on the Execute button to restore the old data.

    Akeneo-Backup-Management-5

    Support

    This was all about the Akeneo Backup Management. I hope you must have the got the idea of our module. Thanks for taking the time in reading this blog. And also, please doesn’t forget to share your feedback and suggestions under the comment box given below.

    Moreover, If you have any queries or suggestions, then feel free to add a ticket to our HelpDesk system.

    Please explore our Akeneo Development Services and Quality Akeneo Extensions.

    Current Product Version - Akeneo 2 to 5 || 2.0.0 and Akeneo 6 || 3.0.0

    Supported Framework Version - Akeneo - 3.0.x, 3.1.x, 3.2.x, 4.0.x, 5.0.x and 6.0.x

    Blog Version - Akeneo - 3.0.x, 3.1.x, 3.2.x, 4.0.x, 5.0.x and 6.0.x
    • Version Akeneo 3.x.x 4.x.x 5.x.x
    • Version Akeneo 2.0.x, 2.1.x, 2.2.x , 2.3.x, 3.0.x, 3.1.x and 3.2.x
    • Version Akeneo - 3.0.x, 3.1.x, 3.2.x, 4.0.x, 5.0.x and 6.0.x
    . . .
    Discuss on Helpdesk

    Leave a Comment

    Your email address will not be published. Required fields are marked*


    Be the first to comment.

    Back to Top

    Table of Content