config-install.asciidoc

Installing a Module

How to install a core or contributed module, using the administrative interface or Drush.

Goal

Install a core module, or a contributed module whose files have already been uploaded to the site, through the administrative interface or using Drush.

Prerequisite knowledge

[understanding-modules] [install-composer]

Site prerequisites

If you want to use Drush to install modules, Drush must be installed. See [install-tools].

Steps

You can use the administrative interface or Drush to install modules.

Contributed modules are not included with the core software must first be downloaded using Composer. See [install-composer] for more information.

Using the administrative interface

1. In the Manage administrative menu, navigate to Extend (admin/modules). The Extend page appears showing all the available modules in your site.

2. Check the boxes for the module or modules you want to install. For example, check the box for the core Ban module.

   

3. Click Install. The checked modules will be installed.

Using Drush

1. In the Manage administrative menu, navigate to Extend (admin/modules). The Extend page appears showing all the available modules in your site.

2. Find the machine name of the module you want to install, by expanding the information area for the module. For instance, the core Ban module’s machine name is ban.

3. Run the following Drush command to install the module:

   drush pm:enable ban

Expand your understanding

If you do not see the effect of these changes in your site, you might need to clear the cache. See [prevent-cache-clear].

Videos

Installing a Module

Your browser does not support the video tag.

Additional resources

Drush

Attributions

Written and edited by Boris Doesborg and Jennifer Hodgdon, and Joe Shindelar at Drupalize.Me.