/magento2-installer-bash-script

Magento 2 Bash Script Installer

Primary LanguageShell

Simplistic Magento 2 Installer

This bash script helps you to quickly install Magento2 from different sources (tar, composer etc.) with sample data for development purpose.

INSTALL

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

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

To make it a system-wide command (preferred)

sudo mv m2-installer.sh /usr/local/bin/m2-installer

OR

mv m2-installer.sh ~/bin/m2-installer

Make sure your $HOME/bin folder is in executable path

USAGE

To display help

m2-installer --help

Magento 2 Installer Help

To install Magento CE v2.4.3 (with sample data)

m2-installer --version=2.4.3 --base-url=magento243.test --install-sample-data --db-user=root --db-pass=pass --db-name=magento243
  • --install-sample-data option is required to install the sample data.

If you want to install via composer, you can simply use --source=composer option:

m2-installer --source=composer --version=2.4.3 --base-url=magento243.test --install-sample-data --db-user=root --db-pass=pass --db-name=magento243

If --source option is not passed, default tar source is used for downloading.

Notes
Since elasticsearch is the default search engine since v2.4.0 onwards. Make sure to install it prior to M2 installation

You can explicitly pass elasticsearch params as

  • --search-engine (default: elasticsearch7)
  • --elasticsearch-host (default: 127.0.0.1)
  • --elasticsearch-port (default: 9200)
  • --elasticsearch-index (default: magento2)

Usage example:

m2-installer --version=2.4.3 --base-url=magento243.test --db-user=root --db-pass=pass --db-name=magento243 --search-engine=elasticsearch7 --elasticsearch-host=127.0.0.1

To install Magento CE 2.4.3 (without sample data)

m2-installer --version=2.4.3 --base-url=magento243.test --db-user=root --db-pass=pass --db-name=magento243

To install Magento with Redis Caching

If you want to use redis as session storage, frontend and full-page caching, you have to use the following params:

  • --use-redis-cache (required)
  • --redis-host (optional, default: 127.0.0.1)
  • --redis-port (optional, default: 6379)

Usage example:

m2-installer --version=2.4.3 --base-url=magento243.test --db-user=root --db-pass=pass --db-name=magento243 --use-redis-cache
m2-installer --version=2.4.3 --base-url=magento243.test --db-user=root --db-pass=pass --db-name=magento243 --use-redis-cache --redis-host=127.0.0.1 --redis-port=6379

Use of --force option

Use --force option, if you want to

  • Skip the installation wizard/confirmation
  • Clean up the directory prior installation

Usage example:

m2-installer --version=2.4.3 --base-url=magento243.test --db-user=root --db-pass=pass --db-name=magento243 --force

Use of config files

If you repeatedly install Magento on your development machine, it is recommended to use the config file in one of the following locations:

  1. ~/.m2-installer.conf - $HOME directory (global scope)
  2. ./.m2-installer.conf - project directory (local/project scope)

You can copy the sample config provided in the repo .m2-installer.conf.dist to the desired location

cp .m2-installer.conf.dist ~/.m2-installer.conf
# OR
cp .m2-installer.conf.dist ./.m2-installer.conf

And edit .m2-installer.conf config file as

# Web Settings
USE_SECURE=1
LANGUAGE='en_US'
CURRENCY='USD'
TIMEZONE='America/Chicago'

# Storage Settings
SESSION_SAVE='files'
# Use 'redis' for Redis caching
CACHING_TYPE=

# Admin Settings
BACKEND_FRONTNAME="backend"
ADMIN_FIRSTNAME='John'
ADMIN_LASTNAME='Doe'
ADMIN_EMAIL='admin@example.com'
ADMIN_USER='admin'
ADMIN_PASSWORD=$(genRandomPassword)

# DB Settings
DB_HOST=localhost
DB_USER=root
DB_PASS=root

# Elasticsearch
SEARCH_ENGINE='elasticsearch7'
ELASTICSEARCH_HOST='127.0.0.1'
ELASTICSEARCH_PORT=9200
ELASTICSEARCH_INDEX_PREFIX='magento2'

# Redis
REDIS_HOST='127.0.0.1'
REDIS_PORT=6379

To update the script

m2-installer --self-update

Note: This option will only work for version > 0.1.2

BONUS 1

You can use this script to quickly install the Magento in your beloved warden environment

cd /path/to/warden/m2/project
warden shell

After login to the container, you can download the script (as mentioned above) and install Magento as

# With sample data
m2-installer --version=2.4.3 --install-sample-data --use-secure --base-url=app.<project>.test --db-host=<project>_db_1 --db-user=magento --db-pass=magento --db-name=magento --elasticsearch-host=<project>_elasticsearch_1 --use-redis-cache --redis-host=<project>_redis_1 --force

# Without sample data
m2-installer --version=2.4.3 --use-secure --base-url=app.<project>.test --db-host=<project>_db_1 --db-user=magento --db-pass=magento --db-name=magento --elasticsearch-host=<project>_elasticsearch_1 --use-redis-cache --redis-host=<project>_redis_1 --force

BONUS 2

After installation, you can create virtual host with this FREE bash script - https://github.com/MagePsycho/nginx-virtual-host-bash-script

sudo vhost-nginx --domain=magento243.test --app=magento2

RoadMap

  • Support of installation parameters via config files (~/.m2-installer.conf or ./.m2-installer.conf)
  • Support multiple compression types (.gz, .zip, .tar.bz2)
  • Option to install Magento 2 Enterprise Edition
  • Option to install via composer
  • Option to install via git clone
  • Option to check system readiness (PHP & it's extensions, MySQL, Nginx/Apache)
  • Option to create virtual host (nginx)
  • Option to create crontab settings
  • Option to migrate with local codebase + database