.. include:: ../common/global.rst Installing Acquia BLT ===================== .. toctree:: :hidden: :glob: /blt/install/windows-install/ /blt/install/tooling/ /blt/install/alt-env /blt/install/creating-new-project/ /blt/install/adding-to-project/ /blt/install/local-development/ /blt/install/next-steps/ /blt/install/updating-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. .. _blt-system-requirements: General requirements -------------------- Regardless of the operating system you use, you must have the following installed tools available for use from the command line: - `Git `__ - `Composer `__ - `PHP 7.2 or later (7.3 recommended) `__ Install the most recent versions of dependencies unless otherwise noted. .. _blt-networking: 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. .. _blt-installation-requirements: Installing dependencies ----------------------- Use the following procedures (based on your operating system) to install the necessary :ref:`dependencies listed above `. .. tabs:: .. group-tab:: macOS To install Acquia BLT dependencies on macOS, complete the following steps: #. 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: .. code-block:: bash sudo xcodebuild -license xcode-select --install #. 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: .. code-block:: bash /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 #. 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 `__. #. Set up your LAMP stack for use with your development, based on your selected environment choice: * `Drupal VM `__: Use the installation instructions in the :ref:`Drupal VM requirements `. .. note:: When using Acquia BLT and Drupal VM on macOS 10.14 (Mojave), you must allow Full Disk Access for the iTerm application for files to be available in Drupal VM. `Learn more `__. * Other LAMP stacks: See :doc:`/blt/install/local-development/`. .. note:: If you are not using a virtual machine (VM) and you want to run Behat tests from the host computer, you will need to use Java. Use the following commands to install Java: .. code-block:: bash brew cask install java brew cask install chromedriver #. If you want to use the `Cog base theme `__ (included with Acquia BLT), run the following command to install additional tools: .. code-block:: bash brew install npm nvm .. note:: Cog uses `npm `__ to install front-end tools. .. group-tab:: Windows **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: #. Run the following command, and press Enter when prompted: .. code-block:: bash sudo add-apt-repository ppa:ondrej/php #. Run the following command: .. code-block:: bash sudo apt-get update #. Run the following command, based on your installed version of Acquia BLT: .. tabs:: .. tab:: 10.x .. code-block:: bash 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 .. tab:: 9.2.x .. code-block:: bash 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 #. Run the following command: .. code-block:: bash php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');" #. Run the following command: .. code-block:: bash php composer-setup.php #. Run the following command: .. code-block:: bash sudo mv composer.phar /usr/local/bin/composer #. Run the following command: .. code-block:: bash curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash - #. Run the following command: .. code-block:: bash 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: .. code-block:: bash git config --global user.email "you@example.com" 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 :doc:`generate an SSH key `. .. group-tab:: Linux 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*: .. code-block:: bash apt-get install git composer drush composer global require hirak/prestissimo:^0.3 composer global require zaporylie/composer-drupal-optimizations:^1.1 - *Fedora*: .. code-block:: bash 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 .. _blt-installing: Installing Acquia BLT --------------------- After you have installed the dependencies, proceed to create a new project with Acquia BLT or add Acquia BLT to an existing project: - :doc:`/blt/install/creating-new-project/` - :doc:`/blt/install/adding-to-project/` If Acquia BLT is already set up for your project and you need instructions on how to get started, see :doc:`/blt/developer/onboarding/`. If you are trying to update an existing version of Acquia BLT, see :doc:`/blt/install/updating-blt/`. .. Next review date 20200422