joomlatools/installer

A Composer plugin to install Joomla extensions into your installation.

Installs: 2 010

Dependents: 8

Stars: 24

Watchers: 17

Forks: 7

Open Issues: 1

Language: PHP

v1.0.6 2015-07-02 23:47 UTC

README

This Composer plugin will install extensions into your Joomla setup.

Usage

Defining a package

The easiest way to get started is by defining a custom package in your composer.jsonfile. All you need is the package file for the extension you wish to install. (ie. the installer file you downloaded from the vendor's website)

Create the composer.json file in the root directory of your Joomla installation and have it look something like this:

    {
        "repositories": [
            {
                "type": "package",
                "package": {
                    "name": "vendor/extension",
                    "type": "joomla-installer",
                    "version": "1.0.0",
                    "dist": {
                        "url": "file:////Users/johndoe/Downloads/com_extension.1.0.0.tar.gz",
                        "type": "tar"
                    },
                    "require": {
                        "joomlatools/installer": "*"
                    }
                }
            }
        ],

        "require": {
            "vendor/extension": "1.0.0"
        }
    }

Using this JSON file, we have now defined our own custom package. Pay attention to the following settings:

  • The type has to be set to joomlatools-installer
  • Make sure the url directive points to the location of the install package.

Executing composer install will now fetch the joomlatools/installer plugin and use it to install the package into your Joomla installation.

For more information on creating these custom packages for projects which do not support Composer, see the Composer docs.

Creating a custom package

To make use of all Composer's features, eg. upgrading to a newer version, you are better off creating a package using your extension's source code.

The package definition should contain the following basic information to make it installable into Joomla:

{
        "name": "vendor/my-extension",
        "type": "joomla-installer",
        "require": {
            "joomlatools/installer": "*"
        }
}

If you want to make your extension available directly from Github or any other VCS, you want to make sure that the file layout in your repo resembles your install package.

You can now publish your extension on Packagist or serve it yourself using your own Satis repository.

For more information on rolling your own package, please refer to the Composer documentation.

Change the user

The installer injects a user called root into the Joomla application at runtime to make sure that the installer scripts have the necessary permissions to execute.

If for some reason, you need to change the details of this mock user, you can override them by adding a joomla block into the config section of your composer.json. Example:

{
    "config": {
        "joomla": {
            "username":  "johndoe",
            "name":      "John Doe",
            "email":     "john@doe.com"
        }
    }
}

Debugging

Having trouble? You can increase Composer's verbosity setting (-v|vv|vvv) to gather more information. Increasing Composer's verbosity will also enable Joomla's log messages.

Requirements

  • Composer
  • Joomla version 2.5 and up.

Contributing

We appreciate any contribution, whether it is related to bugs, grammar, or simply a suggestion or improvement. We ask that any contribution follows a few simple guidelines in order to be properly received.

We follow the GitFlow branching model, from development to release. If you are not familiar with it, there are several guides and tutorials online to learn about it.

There are a few things you must know before submitting a pull request:

  • All changes need to be made against the develop branch. However, it is very well appreciated and highly suggested to start a new feature branch from develop and make your changes in this new branch. This way we can just checkout your feature branch for testing before merging it into develop.
  • We will not consider pull requests made directly to the master branch.

Authors

See the list of contributors.

License

The joomlatools/installer plugin is free and open-source software licensed under the GPLv3 license.