PHPackages opengento/magento-composer-installer - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. opengento/magento-composer-installer ActiveComposer-plugin opengento/magento-composer-installer ==================================== Composer installer for Magento modules 3.1.2(8y ago)07OSL-3.0PHPPHP >=5.5 Since Jan 13Pushed 7y ago8 watchersCompare [ Source](https://github.com/opengento/magento-composer-installer)[ Packagist](https://packagist.org/packages/opengento/magento-composer-installer)[ Docs](https://github.com/magento-hackathon/magento-composer-installer)[ RSS](/packages/opengento-magento-composer-installer/feed)WikiDiscussions master Synced today READMEChangelogDependencies (10)Versions (40)Used By (0) [![Build Status](https://camo.githubusercontent.com/a1b630a212cad62e670ab3c88d82834a3fef39f8d8bff03266099b4a4c340a4c/68747470733a2f2f7472617669732d63692e6f72672f436f7479612f6d6167656e746f2d636f6d706f7365722d696e7374616c6c65722e706e67)](https://travis-ci.org/Cotya/magento-composer-installer)[![Windows Build status](https://camo.githubusercontent.com/70d56dfe1f8de08affdbf4b583aea08925d93bedc5cb169a9892dfbda4ed5d78/68747470733a2f2f63692e6170707665796f722e636f6d2f6170692f70726f6a656374732f7374617475732f31626d353473396a7633363033786c353f7376673d74727565)](https://ci.appveyor.com/project/Flyingmana/magento-composer-installer-396)[![Dependency Status](https://camo.githubusercontent.com/806c4fa0a5e8c84a2d16756442d3d56ab0105e1ccfe3a9bf810fccc721a0e1fd/68747470733a2f2f7777772e76657273696f6e6579652e636f6d2f7068702f6d6167656e746f2d6861636b6174686f6e3a6d6167656e746f2d636f6d706f7365722d696e7374616c6c65722f62616467652e737667)](https://www.versioneye.com/php/magento-hackathon:magento-composer-installer/)[![Reference Status](https://camo.githubusercontent.com/554512c9d96db20ee20a3cd07395d9964577a3dd776c0562e8a64bc93842fff4/68747470733a2f2f7777772e76657273696f6e6579652e636f6d2f7068702f6d6167656e746f2d6861636b6174686f6e3a6d6167656e746f2d636f6d706f7365722d696e7374616c6c65722f7265666572656e63655f62616467652e737667)](https://www.versioneye.com/php/magento-hackathon:magento-composer-installer/references)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/16391a8b6b0249e892e903b0055947e0ab922c5e8c1d714c5b15681ea8990085/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f436f7479612f6d6167656e746f2d636f6d706f7365722d696e7374616c6c65722f6261646765732f7175616c6974792d73636f72652e706e67)](https://scrutinizer-ci.com/g/Cotya/magento-composer-installer/)[![Code Coverage](https://camo.githubusercontent.com/92ec6e7769facdc5d09593d0dd464f1113f883bf43622207fb02243248fdae24/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f436f7479612f6d6167656e746f2d636f6d706f7365722d696e7374616c6c65722f6261646765732f636f7665726167652e706e67)](https://scrutinizer-ci.com/g/Cotya/magento-composer-installer/)[![Bountysource](https://camo.githubusercontent.com/7d43779b1e882bce7935b49d00be82790dc05f8e4aabdcb9f0567ef609f7bb2d/68747470733a2f2f7777772e626f756e7479736f757263652e636f6d2f62616467652f747261636b65723f747261636b65725f69643d323834383732)](https://www.bountysource.com/trackers/284872-magento-hackathon-magento-composer-installer?utm_source=284872&utm_medium=shield&utm_campaign=TRACKER_BADGE) !!! support the maintainer of this project via Patreon: [![Become a Patreon](doc/become_a_patron_button.png)](https://www.patreon.com/Flyingmana) Magento Composer Installer ========================== [](#magento-composer-installer) The purpose of this project is to enable [composer](https://github.com/composer/composer) to install Magento modules, and automatically integrate them into a Magento installation and add Composer's vendor autoloader ability the Magento's so that Composer-compatible 3rd party tools can be used. If you want to install the Magento Core, you should try [AydinHassan/magento-core-composer-installer](https://github.com/AydinHassan/magento-core-composer-installer)as additional plugin. We strongly recommend you to also read the general composer documentations on [getcomposer.org](https://getcomposer.org) Also you should see: - [Using composer correctly (confoo) by Igor Wiedler](https://speakerdeck.com/igorw/using-composer-correctly-confoo) Magento 2 --------- [](#magento-2) Congratulation to work with Magento 2. Dont try to use it together with this project. Your princess is in [another Castle](http://devdocs.magento.com/guides/v2.0/install-gde/prereq/integrator_install.html#integrator-first-composer-ce) Project Details --------------- [](#project-details) This project only covers the custom installer for composer. If you have problems with outdated versions, need to install magento connect modules or similar, you need to look for [packages.firegento.com](https://packages.firegento.com/)which you probably should add as composer repository (globally) `composer config -g repositories.firegento composer https://packages.firegento.com` ### supported PHP Versions [](#supported-php-versions) We don't officially support PHP versions which are [End of Life](https://secure.php.net/eol.php) means which dont get [security patches](https://secure.php.net/supported-versions.php) anymore. Even if the install requirement still allows them. This will change, as soon someone is willing to pay for supporting them. ### support contacts [](#support-contacts) If you have problems please have patience, as normal support is done during free time. If you are willing to pay to get your problem fixed, communicate this from the start to get faster responses. If you need consulting, support, training or help regarding Magento and Composer, you have the chance to hire one of the following people/companies. - Daniel Fahlke aka Flyingmana (Maintainer): [@Flyingmana](https://twitter.com/Flyingmana) - brandung - Magento Team: () other support contacts - irc: freenode the channels #magento-composer #magento-reddit and for german speaking people #magento-de - twitter: [@firegento](https://twitter.com/firegento) ### changelog [](#changelog) See [CHANGELOG.md](CHANGELOG.md). ======= Known issues ------------ [](#known-issues) ### need to redeploy packages [](#need-to-redeploy-packages) earlier we suggested the use of the command integrator package, that is not needed anymore. `composer.phar run-script post-install-cmd -vvv -- --redeploy` This does remove all deployed files and redeploys every module ### using non default autoloading [](#using-non-default-autoloading) we handle this topic in our [FAQ](doc/FAQ.md). ### Timeouts and slow downloading. [](#timeouts-and-slow-downloading) Mostly caused by outages of Github, Repositories or the Internet. This is a common problem with having all packages remote. For all of this issues you can make use of the commercial [Toran Proxy](https://toranproxy.com/). It also allows hosting of private packages and speeds up the whole downloading process. Another alternative is to look into [Satis](https://github.com/composer/satis), bare git mirrors and repository aliasing. Another way to speedup downloads over ssh (also interesting for satis users) is to improve your ssh configs. At least for newer versions of openSSH you can add the following to your `.ssh/config` to reuse previous connections. ``` Host * ControlPath ~/.ssh/controlmasters/%r@%h:%p ControlMaster auto ControlPersist 10m ``` also you need to create the `controlmasters` directory: ``` mkdir ~/.ssh/controlmasters chmod go-xr ~/.ssh/controlmasters ``` further information can be found on [wikibooks](https://en.wikibooks.org/wiki/OpenSSH/Cookbook/Multiplexing) Usage ----- [](#usage) ### Update the Installer [](#update-the-installer) as this is a composer plugin, you should only use this both commands to update the installer ``` composer require --no-update magento-hackathon/magento-composer-installer="3.1.*" composer update --no-plugins --no-scripts magento-hackathon/magento-composer-installer ``` the second command needs maybe a `--with-dependencies` Depending on your workflow with composer, you may want to use more explicite versions ### Install a module in your project [](#install-a-module-in-your-project) make sure to use [the public Magento module repository](https://packages.firegento.com) as composer repository: `composer config -g repositories.firegento composer https://packages.firegento.com` configure your `magento root dir`, the directory where your magento resides: `composer config extra.magento-root-dir "htdocs/"` an example how your project `composer.json` could look like: ``` { "repositories": [ { "type": "composer", "url": "https://packages.firegento.com" } ], "extra":{ "magento-root-dir": "htdocs/" } } ``` ### Auto add files to .gitignore [](#auto-add-files-to-gitignore) If you want to have the deployed files automatically added to your `.gitignore file`, then you can just set the `auto-append-gitignore` key to true: ``` { "extra":{ "magento-root-dir": "htdocs/", "auto-append-gitignore": true } } ``` The `.gitignore` file will be loaded from the current directory, and if it does not exist, it will be created. Every set of module files, will have a comment above them describing the module name for clarity. Multiple deploys will not add additional lines to your `.gitignore`, they will only ever be added once. ### Adding Composer's autoloader to Magento [](#adding-composers-autoloader-to-magento) Documentation available [here](doc/Autoloading.md). ### Overwriting a production setting (DevMode) [](#overwriting-a-production-setting-devmode) ``` { "extra":{ "magento-deploystrategy": "copy", "magento-deploystrategy-dev": "symlink" } } ``` Example in [devmode doc](doc/DevMode.md). ### Include your project in deployment [](#include-your-project-in-deployment) When the magento-composer-installer is run, it only looks for magento-modules among your project's dependencies. Thus, if your project is a magento-module and you want to test it, you will need a second `composer.json` for deployment, where your project is configured as a required package. If you wish to deploy your project's files (a.k.a. root package), too, you need to setup your `composer.json` as follows: ``` { "type": "magento-module", ... "extra": { "magento-root-dir": "htdocs/", "include-root-package": true } } ``` ### Testing [](#testing) First clone the magento-composer-installer, then install the dev-stuff (installed by default): ``` ./bin/composer.phar install ``` then run `vendor/bin/phpunit` in project-root directory. Note: Windows users please run `phpunit` with Administrator permissions. Further Information ------------------- [](#further-information) - [FAQ](doc/FAQ.md) - [Make a Magento module installable with composer](doc/MakeAModuleInstallableWithComposer.md) - [About File Mapping like for example modman](doc/Mapping.md) - [About Deploying files into your Magento root and possible configs](doc/Deploy.md) ### External Links [](#external-links) - [Composer How to Screencast](http://www.youtube.com/watch?v=m_yprtQiFgk) - [Introducing Composer Blog on Magebase.com](http://magebase.com/magento-tutorials/composer-with-magento/) - [Magento, Composer and Symfonys Dependency Injection](http://www.piotrbelina.com/magento-composer-and-dependency-injection/) - [Using Composer for Magento(at engineyard)](https://blog.engineyard.com/2014/composer-for-magento) ### Core Contributors [](#core-contributors) - Daniel Fahlke aka Flyingmana (Maintainer) - Jörg Weller - Karl Spies - Tobias Vogt - David Fuhr - Amir Tchavoshinia - Vinai Kopp (Maintainer) Thank You --------- [](#thank-you) There are a few companies we want to thank for supporting this project in one way or another. \#####[digital.manufaktur GmbH](https://www.digitalmanufaktur.com/) Teached me (Flyingmana) most I know about Magento and paid my participation for the hackathon were the installer got created. \#####[melovely](http://www.melovely.de/) Support me (Flyingmana) as my current employer very much in my work on everything composer related. ### Health Score 31 — LowBetter than 68% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity4 Limited adoption so far Community23 Small or concentrated contributor base Maturity70 Established project with proven stability Bus Factor1 Top contributor holds 55.5% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~44 days Recently: every ~70 days Total 37 Last Release 3260d ago Major Versions 1.3.2 → 2.0.0-beta12014-02-26 2.1.0 → 3.0.0-alpha.12014-11-15 1.3.x-dev → 3.0.0-beta.12015-03-15 2.1.3-rc.1 → 3.0.3-rc.12015-05-03 2.1.3 → 3.0.7-rc.12016-03-08 PHP version history (3 changes)1.3.x-devPHP >=5.3.2 3.0.5PHP >=5.4 3.0.7PHP >=5.5 ### Community Maintainers ![](https://www.gravatar.com/avatar/e0dc7083d3b69773a58a99fb97d6035781a15879197dafeebb523cebf0a952b3?d=identicon)[lhall](/maintainers/lhall) --- Top Contributors [![Flyingmana](https://avatars.githubusercontent.com/u/237319?v=4)](https://github.com/Flyingmana "Flyingmana (436 commits)")[![Vinai](https://avatars.githubusercontent.com/u/72463?v=4)](https://github.com/Vinai "Vinai (140 commits)")[![tobi-pb](https://avatars.githubusercontent.com/u/940631?v=4)](https://github.com/tobi-pb "tobi-pb (66 commits)")[![adragus-inviqa](https://avatars.githubusercontent.com/u/13104649?v=4)](https://github.com/adragus-inviqa "adragus-inviqa (28 commits)")[![AydinHassan](https://avatars.githubusercontent.com/u/2817002?v=4)](https://github.com/AydinHassan "AydinHassan (26 commits)")[![datenbrille](https://avatars.githubusercontent.com/u/795463?v=4)](https://github.com/datenbrille "datenbrille (20 commits)")[![JeroenBoersma](https://avatars.githubusercontent.com/u/1163348?v=4)](https://github.com/JeroenBoersma "JeroenBoersma (8 commits)")[![kristof-ringleff](https://avatars.githubusercontent.com/u/47804013?v=4)](https://github.com/kristof-ringleff "kristof-ringleff (8 commits)")[![lhall-amphibee](https://avatars.githubusercontent.com/u/15910616?v=4)](https://github.com/lhall-amphibee "lhall-amphibee (4 commits)")[![bastianccm](https://avatars.githubusercontent.com/u/1145424?v=4)](https://github.com/bastianccm "bastianccm (4 commits)")[![tkdb](https://avatars.githubusercontent.com/u/5831065?v=4)](https://github.com/tkdb "tkdb (4 commits)")[![vs7](https://avatars.githubusercontent.com/u/1913172?v=4)](https://github.com/vs7 "vs7 (3 commits)")[![nevvermind](https://avatars.githubusercontent.com/u/834932?v=4)](https://github.com/nevvermind "nevvermind (3 commits)")[![scottsb](https://avatars.githubusercontent.com/u/6756989?v=4)](https://github.com/scottsb "scottsb (3 commits)")[![vovayatsyuk](https://avatars.githubusercontent.com/u/306080?v=4)](https://github.com/vovayatsyuk "vovayatsyuk (3 commits)")[![ArnaudLigny](https://avatars.githubusercontent.com/u/80580?v=4)](https://github.com/ArnaudLigny "ArnaudLigny (2 commits)")[![reiz](https://avatars.githubusercontent.com/u/652130?v=4)](https://github.com/reiz "reiz (2 commits)")[![rjocoleman](https://avatars.githubusercontent.com/u/154176?v=4)](https://github.com/rjocoleman "rjocoleman (2 commits)")[![Rud5G](https://avatars.githubusercontent.com/u/27158?v=4)](https://github.com/Rud5G "Rud5G (2 commits)")[![aadmathijssen](https://avatars.githubusercontent.com/u/3796971?v=4)](https://github.com/aadmathijssen "aadmathijssen (2 commits)") --- Tags magentocomposer-installer ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/opengento-magento-composer-installer/health.svg) ``` [![Health](https://phpackages.com/badges/opengento-magento-composer-installer/health.svg)](https://phpackages.com/packages/opengento-magento-composer-installer) ``` ### Alternatives [magento-hackathon/magento-composer-installer Composer installer for Magento modules 214757.6k374](/packages/magento-hackathon-magento-composer-installer)[magento/magento-composer-installer Composer installer for Magento modules 7523.3M318](/packages/magento-magento-composer-installer)[magento/magento2-functional-testing-framework Magento2 Functional Testing Framework 15511.5M30](/packages/magento-magento2-functional-testing-framework)[yireo/magento2-webp2 Magento 2 module to add WebP support to the Magento frontend 2091.2M7](/packages/yireo-magento2-webp2)[yireo/magento2-googletagmanager2 Add Google Tag Manager to Magento 167930.4k5](/packages/yireo-magento2-googletagmanager2)[yireo/magento2-whoops Magento 2 module adding Whoops error handling 102703.5k](/packages/yireo-magento2-whoops) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)