Distributing packages

The previous example is a very basic way to use our Composer plugin. To make use of all Composer's features, for example automatically upgrading to the latest version, you are better off creating a package using your extension's source code.

Create a composer.json file in the root of your project. This file defines your package. The package definition should contain the following basic information to make it installable into Joomla:

    "name": "vendor/my-extension",
    "type": "joomlatools-composer",
    "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.

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

Once published, you can easily install your extension/template/.. using the method we described on the previous page.

We published com_helloworld on GitHub to serve as an example. You can install this component in every Joomla installation by putting joomlatools/composer-helloworld in your composer.json file, or by running the following command:

composer require joomlatools/composer-helloworld

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

Need Help? Let our developers personally assist you. Business or Agency subscribers can ask development related questions in our Support Center.

Join 23000+ others and subscribe to our newsletter!