Magento 2 Media Downloader

This is a bash script to quickly download the catalog images for your Magento 2 development from a LIVE or STAGING server.

When to use this script?

• If you don't have enough space to download the entire media folder
• If the entire media folder is huge to download (time-consuming)
• If you are just concerned with certain category pages for development (no need to download the entire media folder)
• If you are just concerned with certain product pages for development (no need to download the entire media folder)

Moreover, the bash script just works out of the box for any *nix system.
Just copy the script and start downloading the required media files for quick development.

INSTALL

You can simply download the script file and give the executable permission.

curl -0 https://raw.githubusercontent.com/MagePsycho/magento2-media-downloader-bash-script/master/src/m2-media-downloader.sh -o m2-media-downloader.sh
chmod +x m2-media-downloader.sh

To make it system-wide command (recommended)

mv m2-media-downloader.sh ~/bin/m2-media-downloader

#OR
#mv m2-media-downloader.sh /usr/local/bin/m2-media-downloader

USAGE

Configure SSH Settings

It uses rsync command to download the media files from remote.
In order to connect to remote via SSH, you need to configure the settings in either of the following locations:

1. ~/.m2media.conf - Home Directory (global scope)
2. ./.m2media.conf - Project Directory (local scope)

You can copy the .m2media.conf.dist file (sample provided in the repository) to the required location:

cp .m2media.conf.dist ~/.m2media.conf

# OR
# cp .m2media.conf.dist ./.m2media.conf

And edit the setting as

# Location to private key if using (absolute path)
SSH_PRIVATE_KEY=
SSH_USER="user"
SSH_HOST="host"
SSH_PORT=22

# Magento 2 root directory in remote (absolute path)
SSH_M2_ROOT_DIR="/var/www/magento2/"

Execute Commands

To display help

cd /path/to/magento2
m2-media-downloader --help

Note: You have to run the command from Magento 2 root directory

To download all the product images within a category

m2-media-downloader --type=category --id=<categoryId>

To download the product images

m2-media-downloader --type=product --id=<productId>

To test which images will be downloaded
Use --dry-run option as:

m2-media-downloader --type=category --id=<categoryId> --dry-run
m2-media-downloader --type=product --id=<productId> --dry-run

To update the script

m2-media-downloader --update

BONUS 1

How to download wysiwyg images?

Since wysiwyg images are dispatched via ./pub/get.php, you can modify the code as shown below.

Find the following code in file ./pub/get.php

if (!$isAllowed($relativePath, $allowedResources)) {
    require_once 'errors/404.php';
    exit;
}

And replace by the chunk below

if (!$isAllowed($relativePath, $allowedResources)) { 
    $liveBaseUrl = 'https://mystore.com'; # EDIT
    try {
        $absoluteFilePath = BP . '/pub/' . $relativePath;
        $absoluteFileUrl = rtrim($liveBaseUrl, '/') . '/' . $relativePath;
        $absoluteFileDir = dirname($absoluteFilePath);
        if (!is_dir($absoluteFileDir)) {
            mkdir($absoluteFileDir, 0777, true);
        }
        file_put_contents($absoluteFilePath, file_get_contents(trim($absoluteFileUrl)));
        # Uncomment if you want log the downloaded files
        #file_put_contents(BP . '/var/log/wysiwyg-images.log', $absoluteFilePath . ' -> ' . $absoluteFileUrl . PHP_EOL, FILE_APPEND | LOCK_EX);
    } catch (Exception $e) {
        require_once 'errors/404.php';
        exit;
    }
}

Now your homepage will also look cool!

BONUS 2

If you want to backup the entire media folder along with code & database, you can use this script:
https://github.com/MagePsycho/magento2-db-code-backup-bash-script

TODOS

• Support of --dry-run option
• Option to download entire media folder (maybe not required, see BONUS 2)
• Download color swatches in case of configurable product
• Option to download by multiple product/category ids