Find and install a contributed project from Drupal.org

Needs revision -- Last peer review: 17 Oct 2012
Description: 
This lesson steps you through locating, evaluating and installing a contributed project from Drupal.org.
Overview: 

In this lesson we use a concrete use case: translating your content to Pirate speak! This lesson will help you learn how to find what you need on Drupal.org, evaluate what you find and download and install the module.

Steps: 
  1. Go to the Drupal.org module section and find the contributed (contrib) module that meets the use case in the overview above.
  2. From the identified module's project page evaluate it for:
    1. Whether or not the module has an official release, preferably a recommended release in a non-alpha, beta or release candidate stage (under Downloads)
    2. The recentness of official releases and development snapshots (under Downloads)
    3. The maintenance status, "actively maintained" is ideal (under Project Information)
    4. The development status, "under active development" is ideal (under Project Information)
    5. For available documentation (typically under Resources or project description)
    6. For a demo site (typically under Resources or project description)
    7. For continuing improvements in issue queue, by developer and/or community (review issue statistics and queue)
    8. The amount of open bugs or issues vs. total (review issue statistics and queue)
    9. For total number of downloads or number of Reported installs over time (under Project Information and View usage statistics)
    10. Whether the module is Feature ready (review project description, issue queue or code)
    11. Whether the module's dependencies are already in use in your environment
  3. Download, install and configure a contributed module (for a more comprehensive guide please see http://drupal.org/documentation/install/modules-themes/modules-7)
  4. From the identified module's project page, find the Downloads section.
  5. Click on the .tar.gz or .zip link to download the module.
  6. Extract the files. The downloaded module package will be in a compressed file format such as 'tar.gz'. On Windows, use a program like 7-zip to extract the files. On modern Mac systems, double-click the .tar.gz file. For *nix systems, use the command line:
    tar -zxvf modulename-drupalversionnumber.tar.gz
    You should see a list of files extracted into a folder.
  7. Copy to your Drupal site folder. The modules folder at the top level of your Drupal installation is reserved for Drupal core modules (the ones that come with the original download of Drupal). Contributed modules belong in sites/all/modules. Copy or move the extracted module folder to this folder.
  8. 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 file has no .txt extension. If you double-click it, your computer won't know what program to use. In that case, open a text editor first, and then open the file using the editor's 'file open' command.
  9. Enable the module. Navigate to Administer > Modules or http://example.com/admin/modules. Check the 'Enabled' box next to the module and then click the 'Save Configuration' button at the bottom. Note: If you are updating an existing module, you'll need to click 'update script' at the top of the page or load http://www.example.com/update.php, then click 'Continue' (after making a backup of both your database and 'sites' folder).
  10. Set up permissions. Some modules will require that you change permissions to get them working. Permissions information may be in the instructions that came with the module. Navigate to Administer > Modules and click on the 'Permissions' button for the desired module. placement of configure and permissions buttons for modules in Drupal 7You can also do this on the Permissions page (Administer > People > Permissions). Scroll down to see if the module appears in the list and, if it does, give the appropriate permissions to desired roles.
  11. Adjust settings. Most modules will have some type of settings page. It will vary from module to module but if not described in the README.txt file, it can usually be located by navigating to (Administer > Modules) and clicking on the 'Configure' link for that module. Not all modules have settings pages.

For contributed theme's the process above is very similar. Where it differs is the location to find themes and where to enable the theme (http://www.example.com/admin/appearance).

Lesson tags:

Comments

bendygirl's picture

need to add devel and directions for adding through the GUI as well (and possible problems)

Update status: 
Needs revision

The "Dialectic" pirate speak module has no README file in the download. Great example, but may not be the best for illustrating potential compatibility issues or requirements to new users.