How to install a Drupal 8 module

You can add new functionality to Drupal by adding modules from the module archive at Drupal.org to your codebase.

Remote Administration logo If you’re a Remote Administration subscriber who has purchased premium Remote Administration services, you can contact Acquia Support to add and enable modules for you.

Adding modules to your codebase

To add modules to your codebase, use one of the following methods:

After adding the module to your codebase, enable it using the Drupal interface or with a Drush command.

Adding a module using Composer

To add a new module to your codebase using Composer, complete the following steps:

  1. Ensure that you have Composer installed locally in your development environment.

  2. Open a command prompt window to access your website’s code.

  3. Using the cd command, navigate to the directory containing your website’s composer.json file, which is typically the directory above your website’s docroot.

  4. Run the following command:

    composer require drupal/[module_name]
    

    where [module_name] is the project name from Drupal.org. This command will download the module to the appropriate place in your code repository, and add the following instructions to the require statement in your composer.json file, again replacing [module_name] with the project name from Drupal.org:

    "require": {
    "drupal/[module_name]": "1.x-dev"
    },
    
  5. Commit the changes to your branch and push the changes to your code repository. For information about deploying your code on Acquia Cloud, see Code workflows on Acquia Cloud.

After you have added a module, you should enable it.

Note

To learn more about using Composer to manage dependencies, see Using Composer to manage Drupal site dependencies on Drupal.org.

For procedures that you can use to set up and use Composer locally with your Acquia Cloud-hosted websites, see Using Composer with Drupal 8 sites. The Drupal community also offers support for using Composer to install Drupal packages on Drupal.org.

Adding a module using Drush

In some cases, you can also install and enable modules using a Drush command, though Composer is the preferred method for Drupal 8. To install and enable a module using Drush, complete the following steps:

  1. Open a command prompt window to access your website’s code.

  2. Using the cd command, navigate to your website’s docroot.

  3. To download the module, run the following command:

    drush dl [module_name]
    

    where [module_name] is the project name from Drupal.org. For example, the project name for the Acquia Connector module is acquia_connector, from https://www.drupal.org/project/acquia_connector

    Note

    You can append -y to the preceding command to accept the confirmation questions that Drush displays.

  4. Commit the change to your branch and push the change to your code repository.

After you have added a module, you should enable it.

Enabling a module in your codebase

After adding a module to your codebase, you can enable it by either using Drush or by using the Drupal user interface.

Enabling a module using Drush

To enable the module from the command line, perform the following steps:

  1. Open a command prompt window to access your website’s code.

  2. Using the cd command, navigate to your website’s docroot.

  3. To download the module, run the following command:

    drush en [module_name]
    

    where [module_name] is the project name from Drupal.org.

    Note

    You can append -y to the preceding command to accept the confirmation questions that Drush displays.

After enabling your desired module, you should review next steps to complete the module’s configuration.

Enabling a module using the Drupal user interface

To enable a module from the Drupal user interface, complete the following steps:

  1. Sign in to your website as an administrator.
  2. Go to the Modules page by using one of the following methods:
    • In the administrative menu, click Extend.
    • In your browser’s address bar, go to http://[your_site]/admin/modules (where [your_site] is your website’s URL).
  3. In the module list, find the module that you want to enable, and then select its check box.
  4. Scroll to the bottom of the webpage, and then click Install.

After enabling your desired module, you should review next steps to complete the module’s configuration.

Next steps

After you have added and enabled a module locally, you will probably need to configure the module’s settings or make changes to website user permissions. For additional information regarding these next steps, be sure to review the documentation provided either with your module or on your module’s Drupal.org project page.

For information about deploying your code on Acquia Cloud, see Code workflows on Acquia Cloud.

Contact supportStill need assistance? Contact Acquia Support

Acquia: Think Ahead

53 State Street, 10th Floor
Boston, MA 02109
United States
Phone: 888-922-7842

Map: Google Maps
View other locations