Information for: DEVELOPERS   PARTNERS

Installing Acquia BLT

Note

You must use Composer to install Acquia BLT. Don’t clone the Acquia BLT repository unless you are contributing to the Acquia BLT project.

General requirements

Regardless of the operating system you use, you must have the following installed tools available for use from the command line:

Install the most recent versions of dependencies unless otherwise noted.

Networking considerations

Building project dependencies requires your local computer to make HTTP and HTTPS requests to several remote software providers. Your local- and network-level security settings must not block requests.

If you must make requests using a proxy server, configure Git to use a proxy, which will address all Git-based requests made by Composer.

Installing dependencies

Use the following procedures (based on your operating system) to install the necessary dependencies listed above.

To install Acquia BLT dependencies on macOS, complete the following steps:

  1. Ensure that you have installed Xcode. Xcode is required to support Homebrew, and you can install Xcode on macOS 10.9 or greater by running the following commands:

    sudo xcodebuild -license
    xcode-select --install
    
  2. Install the minimum dependencies for Acquia BLT. Although you can use the following commands to use Homebrew to install the needed packages, you are not required to use a package manager:

    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
    brew install php git composer
    composer global require hirak/prestissimo:^0.3
    composer global require zaporylie/composer-drupal-optimizations:^1.1
    
  3. Install Drush only as a dependency of individual projects (instead of installing Drush system-wide). Acquia BLT will manage this dependency for you with projects, but for you to run Drush commands independently of Acquia BLT commands, install the Drush Launcher.

  4. Set up your LAMP stack for use with your development. See Local development with Acquia BLT.

  5. If you want to use the Cog base theme (included with Acquia BLT), run the following command to install additional tools:

    brew install npm nvm
    

    Note

    Cog uses npm to install front-end tools.

Requirements

Acquia BLT on Windows has the following requirements:

  • Running a 64-bit version of Windows 10 Anniversary update (build 14393 or greater).

  • Access to a local account with administrative rights for Acquia BLT’s initial installation.

  • Windows Subsystem for Linux (installation instructions)

    Note

    You must create a UNIX username with a password when prompted at the end of the installation process. Certain Acquia BLT commands will not function if you install the Windows Subsystem for Linux using an account without a password.

    If you cannot use WSL, you can instead set up virtualization, and then run Acquia BLT in a virtual machine (VM) or container running Windows, based on the following tools:

    • Docksal: Supports VirtualBox and Docker
    • Lando: Supports Docker

Installation

To install the required applications for Acquia BLT (including PHP, Node.js, Git, and Composer), run the following commands:

  1. Run the following command, and press Enter when prompted:

    sudo add-apt-repository ppa:ondrej/php
    
  2. Run the following command:

    sudo apt-get update
    
  3. Run the following command, based on your installed version of Acquia BLT:

    sudo apt-get install -y php7.2-cli php7.2-curl php7.2-xml php7.2-mbstring php7.2-bz2 php7.2-gd php7.2-mysql mysql-client unzip git
    
    sudo apt-get install -y php5.6-cli php5.6-curl php5.6-xml php5.6-mbstring php5.6-bz2 php5.6-gd php5.6-mysql mysql-client unzip git
    
  4. Run the following command:

    php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
    
  5. Run the following command:

    php composer-setup.php
    
  6. Run the following command:

    sudo mv composer.phar /usr/local/bin/composer
    
  7. Run the following command:

    curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
    
  8. Run the following command:

    sudo apt-get install -y nodejs
    

Configuring Git

Before working with an Acquia BLT project, you must identify yourself to Git by running the following commands:

git config --global user.email "[email protected]"
git config --global user.name "Your Name"

If you haven’t already configured an SSH identity (useful for working with projects on GitHub and interacting with your websites on Acquia Cloud), you should generate an SSH key.

Linux is fully supported by both Acquia BLT and Drupal VM, and shares many of the same dependencies as macOS (except for Xcode). Run the commands based on your installed version of Linux to install Acquia BLT:

  • Ubuntu or Debian:

    apt-get install git composer drush
    composer global require hirak/prestissimo:^0.3
    composer global require zaporylie/composer-drupal-optimizations:^1.1
    
  • Fedora:

    sudo dnf install -y git composer drush
    composer global require "hirak/prestissimo:^0.3"
    # To use NFS with Vagrant, nfs-utils package needs to be
    # installed and nfs-server needs to be running.
    # https://developer.fedoraproject.org/tools/vagrant/vagrant-nfs.html
    sudo dnf install -y nfs-utils && sudo systemctl enable nfs-server
    # Enable nfs, rpc-bind and mountd services for firewalld
    sudo firewall-cmd --permanent --add-service=nfs \
        && sudo firewall-cmd --permanent --add-service=rpc-bind \
        && sudo firewall-cmd --permanent --add-service=mountd \
        && sudo firewall-cmd --reload
    

Installing Acquia BLT

Acquia BLT version 12 and above can be added to almost any Drupal distribution or existing application: Adding Acquia BLT to an existing project
Acquia BLT version 11 and below only supports creating new projects from scratch using the BLT project template: Creating a new project with Acquia BLT

If Acquia BLT is already set up for your project and you need instructions on how to get started, see Onboarding with Acquia BLT. If you are trying to update an existing version of Acquia BLT, see Updating Acquia BLT.