Type:

com_installer

Access:

menu=>Installers=>Modules

User Level:

Administrator; Super Administrator

Screenshot:

Install a New Module

Toolbar:

Uninstall: Select the radio button next to the Module that is to be uninstalled (deleted) from the web site. Then click the Uninstall icon.

Warning: Uninstalling a Module deletes it completely from the system. Any other Extensions that depend upon it will also no longer work.

Help: Click the Help icon at any time to view this Help Screen.

Install New Modules:

NOTE: Many new Modules (and Templates, Mambots(Plugins), and Components) are packaged inside a .zip file with documentation and other Extensions (Therefore there are .zip files and other items inside the .zip file). It is good practice to check this before attempting the new installation as it may be necessary to unpack this file first of all and then install the individual Extensions separately via the appropriate installer.

To Upload and Install a New Module:

If the host web server has GZIP support enabled with PHP, it is possible to upload a zipped (.zip) package file that will be installed automatically.

To trace the file click on the Browse button. This will open the File Upload dialogue window. Navigate to the location of the desired Template file on the local hard drive. Select the Module file and click the Open button. The dialogue window will disappear and the path to, and name of, the Module file will appear in the File Upload field. Click the Upload and Install button to complete the transfer and installation of a copy of the Module file from the local computer to the joomla_root/modules/ directory tree.

NOTE: There is usually an upper limit to the size of files that can be uploaded within the web server itself. This limit is set in the PHP configuration file (php.ini) and may differ between web servers and web hosts. The limit cannot be altered from within Joomla!. Some hosting companies do not allow the limit to be altered at all!

To allow larger files to be uploaded it will probably be necessary to increase the upload_max_filesize and the post_max_size settings.

For very large files it may also be necessary to increase the max_execution_time and the memory_limit settings. Alternatively it may be necessary to use an external program to upload the files. If so follow the next set of instructions.

To Install a New Module From a Directory:

If the host web server does not have GZIP support enabled with PHP it will be necessary to transfer the Module file to the web server using FTP (File Transfer Protocol) or possibly a web host provided control panel, bit these are varied and outside the scope of this Help Screen.

Unpack the compressed .zip file onto the local hard drive before uploading it via FTP. Ideally the file should be transferred to the joomla_root/administrator/componentrs/com_installer/module/yourmodulename directory of Joomla!.

Once the files are uploaded enter the exact location of this file (it must be the absolute location) in this example: joomla_root/administrator/components/com_installer/module/yourmodulename then click the Install button.

The new Module will be installed by Joomla! in the joomla_root/modules/yourmodulename directory of the web site.

The Success (or Failure Screen)

If all goes well a page will be displayed proclaiming Upload Module - Success. This confirms the name of the Module installed together with the authors Module description message.

The new Module will have been installed by Joomla! in the joomla_root/modules/yourmodulename directory of the web site.

If things did not go to plan the message Upload Module - Failed, followed usually by the reason for the failure. Make a note of the reason before clicking continue. Rectify the error, if possible, before trying again.

The newly installed Module will now be accessible via the appropriate Module Manager in menu=>Modules=>Site (or Admin) Modules Menu Item. The Module is also listed in the Installed Modules Manager within the Installer screen.

NOTE:To use the new Module ensure that it is Published after the installation is complete and that any necessary Menu Item shortcuts are created in the Front-end Menus.

Installed Modules

This section of the Installer screen contains a listing of all the installed (and editable) Modules within this installation. Essential Core Modules that cannot be deleted are not included in the list.

Columns:

Module File: Lists all the Modules currently installed on the web site (these are only those that are not a part of the core operation of the Joomla! installation).

Client: Identifies whether the installed Modules are used in the Site (Front-end) or the Admin (Back-end) areas of the web site.

Author: This column identifies the name of the Developer/Author of the Module. The information displayed here is copied by Joomla! directly from the module_name.xml file that is included in a normal Module installation.

Version: This column identifies the Version Number of the Module. The information displayed here is copied by Joomla! directly from the module_name.xml file that is included in a normal Module installation.

Date: This column identifies the date upon which the Module was released. The information displayed here is copied by Joomla! directly from the module_name.xml file that is included in a normal Module installation.

Author E-mail: This column identifies the e-mail address of the Author of the Module. The information displayed here is copied by Joomla! directly from the module_name.xml file that is included in a normal Module installation.

Author URL: This column identifies the web site address of the Author of the Module. The information displayed here is copied by Joomla! directly from the module_name.xml file that is included in a normal Module installation.

Uninstalling a Module:

Select the radio button next to the Module that is to be uninstalled (deleted) from the web site. Then click the Uninstall icon.

Warning: Uninstalling a Module deletes it completely from the system. Any other Extensions that depend upon it will also no longer work. Deleted Modules cannot be restored as a Menu Item or Content Item can. If the Module is required again it must be re-installed from the beginning.

NOTE: Modules essential to core Joomla! operations cannot be deleted.

Upgrading Modules:

There is no standard procedure for updating a Module. In some cases it is necessary to uninstall an existing version before adding the new. In other situations the update will be handled automatically.

It is therefore essential to read the Module developers upgrade notes - these may be enclosed in the file that is downloaded, or will be located on the developers web site. 

Related Information:

NOTE: If you have any comments or suggestions regarding this Help screen then please post them in the Suggestions, Modifications, and Corrections forum in the User Documentation Work Group.

Thank you!

The User Documentation Team