Actions

Difference between revisions of "Installing an extension"

From Joomla! Documentation

m (recategorizing to Extensions)
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 +
<noinclude>{{redirectstohere|How do you install an extension?}}</noinclude>
 +
 
Before starting it always is wise to read the documentation associated with an extension. Most extensions have homepages and forums, and it is a good idea to look at them first. If there is a README file included with the extension, you should read it.
 
Before starting it always is wise to read the documentation associated with an extension. Most extensions have homepages and forums, and it is a good idea to look at them first. If there is a README file included with the extension, you should read it.
  
 
For most extensions and most users, the procedure will be:
 
For most extensions and most users, the procedure will be:
  
    * Download the extension to your local machine
+
* Download the extension to your local machine as a zip file package.
    * From the backend of your joomla site (adminsitration) select Extensions.
+
* From the backend of your Joomla site (administration) select Extensions -> Install/Uninstall.
    * Browse for the package file
+
* Click the Browse button and select the extension package on your local machine.
    * Click the install icon
+
* Click the Upload File & Install button.
    * Follow any instructions  
+
* Some extensions may provide further instructions on installation.
 
+
* Note that modules and plugins must be enabled before they will work.
  
 
There are some situations in which this procedure will not work.
 
There are some situations in which this procedure will not work.
  
Sometimes you need to unzip the file locally prior to installing. If you get an error saying that the file is not in the correct format, the need to unzip is a common cause of this. After unzipping try installing the individual items. Note that the files you upload using the installed still need to be zipped.
+
Sometimes you need to unzip the file locally prior to installing. If you get an error saying that the file is not in the correct format, the need to unzip is a common cause of this. After unzipping try installing the individual items. Note that the files you upload using the installer still need to be zipped.
  
 
Sometimes you cannot use the automated installer. For example, very large extensions may exceed the maximum upload size allowed by your host.
 
Sometimes you cannot use the automated installer. For example, very large extensions may exceed the maximum upload size allowed by your host.
Line 20: Line 22:
 
<pre>Warning: is_dir() [function.is-dir]: open_basedir restriction in effect. File(/) is not within the allowed path(s): ...</pre>
 
<pre>Warning: is_dir() [function.is-dir]: open_basedir restriction in effect. File(/) is not within the allowed path(s): ...</pre>
  
this is because of a restriction of your hosting account and a Joomla bug (trying to check if the root directory exists).  You not be able to use the automated installer.
+
this is because of a restriction of your hosting account which leads Joomla! to try to check if the root directory exists.  You will not be able to use the automated installer.
  
 
==Manual Installation==
 
==Manual Installation==
  
First, unzip all of the files locally. Then transfer the files to a folder in the the install directory(for example administrator/components/com_installer/components) for the type of extension you are installing (using FTP). Then use the installer, but select "install from directory" indicating the correct folder name.  This folder name should be (an absolute path? relative to the Docroot? or the filesystem?)
+
First, unzip all of the files locally. Then transfer the files (using FTP) to a folder in the install directory (for example administrator/components/com_installer/components) for the type of extension you are installing. Then use the installer, but select "install from directory" indicating the correct folder name.  This folder name should be an absolute path from the root of the filesystem.
 
+
<noinclude>
For modules and mambots/plugins to work, you must make sure that they are pubished (1.0) or enabled (1.5).  
+
[[Category:Installation]]
 
+
[[Category:Extensions]]
[[Category:FAQ]]
+
</noinclude>
[[Category:Administration FAQ]]
+
[[Category:Installation FAQ]]
+
[[Category:Version 1.5 FAQ]]
+

Latest revision as of 16:43, 4 August 2012

Before starting it always is wise to read the documentation associated with an extension. Most extensions have homepages and forums, and it is a good idea to look at them first. If there is a README file included with the extension, you should read it.

For most extensions and most users, the procedure will be:

  • Download the extension to your local machine as a zip file package.
  • From the backend of your Joomla site (administration) select Extensions -> Install/Uninstall.
  • Click the Browse button and select the extension package on your local machine.
  • Click the Upload File & Install button.
  • Some extensions may provide further instructions on installation.
  • Note that modules and plugins must be enabled before they will work.

There are some situations in which this procedure will not work.

Sometimes you need to unzip the file locally prior to installing. If you get an error saying that the file is not in the correct format, the need to unzip is a common cause of this. After unzipping try installing the individual items. Note that the files you upload using the installer still need to be zipped.

Sometimes you cannot use the automated installer. For example, very large extensions may exceed the maximum upload size allowed by your host.

Also, If you see an error like this:

Warning: is_dir() [function.is-dir]: open_basedir restriction in effect. File(/) is not within the allowed path(s): ...

this is because of a restriction of your hosting account which leads Joomla! to try to check if the root directory exists. You will not be able to use the automated installer.

Manual Installation

First, unzip all of the files locally. Then transfer the files (using FTP) to a folder in the install directory (for example administrator/components/com_installer/components) for the type of extension you are installing. Then use the installer, but select "install from directory" indicating the correct folder name. This folder name should be an absolute path from the root of the filesystem.