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.json file. 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)

Update the composer.json file in the root directory of your Joomla installation by adding the following properties:

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

        ...

    	"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-extension
Make sure the url directive points to the location of the install package.

Executing composer install will now fetch the joomlatools/composer 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": "joomlatools-extension",
    	"require": {
        	"joomlatools/composer": "*"
    	}
}

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.

If you want to move the main Joomla installer manifest to the repository root before running the installation, provide the following information in your composer.jsonfile:

{
	"extra": {
    	"manifest": "path/to/manifest/joomlatools.xml"
	}
}

If the package is for a Joomlatools Framework reusable component, provide the following information in your composer.jsonfile:

{
	"extra": {
    	"joomlatools-component": "component-name"
	}
}

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.

For more information, FAQ and examples, refer to our developer documentation.

Development

Refer to the wiki on how to set up this repository for local development.

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 3.6+

Contributing

The joomlatools/composer plugin is an open source, community-driven project. Contributions are welcome from everyone. We have contributing guidelines to help you get started.

Contributors

See the list of contributors.

License

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

Community

Keep track of development and community news.

Follow @joomlatoolsdev on Twitter
Join joomlatools/dev on Gitter
Read the Joomlatools Developer Blog
Subscribe to the Joomlatools Developer Newsletter

joomlatools / installer

Maintainers

Details