Installing Modules

Create a modules directory in sites/all.

sites/all/modules

Contributed modules placed in the sites/all/modules directory will be available to all sites sharing the same code base. If you are not creating a multi-site installation then this is where your modules belong.

The basic instructions are as follows: Download the module, extract the files, upload the resulting folder, and enable the module in administer > site building > modules.

Tip

Install new modules you are unfamiliar with on a test site. This way you can explore the functionality without risking your live site.

The detailed instructions are:

1. Download the module. Make sure the version of the module matches your version of Drupal. Note that modules labeled "CVS" or "DEV" are in a development stage. They may be written for a previous/current/future version of Drupal, and they are considered unstable and should be handled with care.

2. Extract the files. When you first get the module, it will appear in a compressed file format such as 'tar.gz'. On Windows, use a program like 7-Zip to extract it. On the Mac, you can use Stuffit Expander. To extract the file using the Unix command line:

   tar -zxvf modulename-drupalversionnumber.tar.gz

   You should see a list of files extracted into a folder.

3. Upload the folder. FTP/Copy/SCP your files to the desired modules folder in your Drupal installation. Since the /modules/ folder is typically reserved for Drupal core modules, you should create a sites/all/modules/ directory and put uploaded modules there. This will also make it easier to update your Drupal site later on as your modules will not be mixed in with core modules.

4. Read the directions. If the module has an installation file (usually INSTALL.txt and/or README.txt), read it for specific instructions. There are modules that require special treatment, and even modules that depend on other downloaded files to function properly. Sometimes the readme filename has no .txt extension. When you try to double-click on it, your computer doesn't know what program to use. Use your favorite text editor.

5. Enable the module. Version 5.x users go to administer > site building > modules. Check the 'Enabled' box next to the module and then click the 'Save Configuration' button at the bottom. NOTE: If you're upgrading an existing module you'll need to browse to your update page at www.example.com/update.php and click on 'run the database upgrade script'.

6. Set permissions. Some modules will require you to change permissions or settings to get them working. Permissions and settings info may be in the instructions that came with the module. Usually, go to administer > users > access control. Scroll down to see if the module appears in the list and, if it does, give the appropriate permissions to the appropriate roles.

7. Adjust settings. Where will depend on the module you installed.

If you run into problems, check the module's issue queue and search the forums. If your problem hasn't already been addressed, post a question and someone will try to help you out.