{"id":13519495,"url":"https://github.com/Cotya/magento-composer-installer","last_synced_at":"2025-03-31T13:30:49.058Z","repository":{"id":25320591,"uuid":"28747520","full_name":"Cotya/magento-composer-installer","owner":"Cotya","description":"Composer installer for Magento modules","archived":false,"fork":false,"pushed_at":"2024-06-09T10:22:47.000Z","size":1247,"stargazers_count":210,"open_issues_count":27,"forks_count":77,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-03-25T07:08:25.501Z","etag":null,"topics":["composer","magento","magento-1","openmage"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cotya.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"Flyingmana","patreon":"Flyingmana","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://www.amazon.de/hz/wishlist/ls/3ENQNOML0W64Y"]}},"created_at":"2015-01-03T15:44:45.000Z","updated_at":"2024-12-09T23:05:30.000Z","dependencies_parsed_at":"2024-01-06T00:43:32.552Z","dependency_job_id":"09910d2f-128c-4c7f-b40f-1cf7b0eebdcc","html_url":"https://github.com/Cotya/magento-composer-installer","commit_stats":{"total_commits":809,"total_committers":78,"mean_commits":"10.371794871794872","dds":0.546353522867738,"last_synced_commit":"ece5cc5bb2a0150a743619901543036597f9eb5b"},"previous_names":[],"tags_count":41,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cotya%2Fmagento-composer-installer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cotya%2Fmagento-composer-installer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cotya%2Fmagento-composer-installer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cotya%2Fmagento-composer-installer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cotya","download_url":"https://codeload.github.com/Cotya/magento-composer-installer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246403912,"owners_count":20771530,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["composer","magento","magento-1","openmage"],"created_at":"2024-08-01T05:01:59.696Z","updated_at":"2025-03-31T13:30:48.576Z","avatar_url":"https://github.com/Cotya.png","language":"PHP","funding_links":["https://github.com/sponsors/Flyingmana","https://patreon.com/Flyingmana","https://www.amazon.de/hz/wishlist/ls/3ENQNOML0W64Y","https://www.patreon.com/Flyingmana"],"categories":["PHP","Composer","Composer Integration","Extensions"],"sub_categories":["Full Page Caching","Free"],"readme":"[![Build Status](https://travis-ci.org/Cotya/magento-composer-installer.svg)](https://travis-ci.org/Cotya/magento-composer-installer)\n[![Windows Build status](https://ci.appveyor.com/api/projects/status/1bm54s9jv3603xl5?svg=true)](https://ci.appveyor.com/project/Flyingmana/magento-composer-installer-396)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Cotya/magento-composer-installer/badges/quality-score.png)](https://scrutinizer-ci.com/g/Cotya/magento-composer-installer/)\n[![Code Coverage](https://scrutinizer-ci.com/g/Cotya/magento-composer-installer/badges/coverage.png)](https://scrutinizer-ci.com/g/Cotya/magento-composer-installer/)\n[![Bountysource](https://www.bountysource.com/badge/tracker?tracker_id=284872)](https://www.bountysource.com/trackers/284872-magento-hackathon-magento-composer-installer?utm_source=284872\u0026utm_medium=shield\u0026utm_campaign=TRACKER_BADGE)\n\n!!! support the maintainer of this project via Patreon: [https://www.patreon.com/Flyingmana](https://www.patreon.com/Flyingmana)\n\n[![Become a Patreon](doc/become_a_patron_button.png)](https://www.patreon.com/Flyingmana)\n\n# Magento Composer Installer \n\nThe purpose of this project is to \nenable [composer](https://github.com/composer/composer) to install Magento modules,\nand automatically integrate them into a Magento installation and add Composer's vendor autoloader\nability to Magento's so that Composer-compatible 3rd party tools can be used.\n\nIf you want to install the Magento Core, you should try\n[AydinHassan/magento-core-composer-installer](https://github.com/AydinHassan/magento-core-composer-installer)\nas an additional plugin.\n\nWe strongly recommend you to also read the general composer documentation at [getcomposer.org](https://getcomposer.org)\n\nAlso you should see:\n\n * [Using composer correctly (confoo) by Igor Wiedler](https://speakerdeck.com/igorw/using-composer-correctly-confoo)\n \n \n## Magento 2\n\nCongratulation to be working with Magento 2. Don't try to use it together with this project.\nYour princess is in [another Castle](http://devdocs.magento.com/guides/v2.0/install-gde/prereq/integrator_install.html#integrator-first-composer-ce)\n \n## Project Details\n \nThis project only covers the custom installer for composer. If you have problems with outdated versions,\nneed to install magento connect modules or similar, you need to look for [packages.firegento.com](https://packages.firegento.com/)\nwhich you probably should add as composer repository (globally)\n\n```composer config -g repositories.firegento composer https://packages.firegento.com```\n\n### supported PHP Versions\n\nWe don't officially support PHP versions which are [End of Life](https://secure.php.net/eol.php) means which they don't get [security patches](https://secure.php.net/supported-versions.php) anymore. Even if the install requirement still allows them.  \nThis will change, as soon as someone is willing to pay for supporting them.\n\n### support contacts\n \nIf you have problems please have patience, as normal support is done during free time.  \nIf you are willing to pay to get your problem fixed, communicate this from the start to get faster responses.\n \nIf you need consulting, support, training or help regarding Magento and Composer,\nyou have the chance to hire one of the following people/companies.\n \n* Daniel Fahlke aka Flyingmana (Maintainer): flyingmana@googlemail.com [@Flyingmana](https://twitter.com/Flyingmana)\n* brandung - Magento Team: magento-team@brandung.de (http://brandung.de)\n \nother support contacts\n \n* irc: freenode the channels #magento-composer #magento-reddit and for german speaking people #magento-de \n* twitter: [@firegento](https://twitter.com/firegento)\n\n### changelog\n\nSee [CHANGELOG.md](CHANGELOG.md).\n\n=======\n## Known issues\n\n### need to redeploy packages\n\nearlier we suggested the use of the command integrator package, that is not needed anymore.\n```composer.phar run-script post-install-cmd -vvv -- --redeploy```  \nThis does remove all deployed files and redeploys every module\n\n### using non default autoloading\n\nwe handle this topic in our [FAQ](doc/FAQ.md).\n\n### Timeouts and slow downloading. \n\nMostly caused by outages of Github, Repositories or the Internet. This is a common problem with having all \npackages remote.\n\nFor all of this issues you can make use of the commercial [Toran Proxy](https://toranproxy.com/).\nIt also allows hosting of private packages and speeds up the whole downloading process.\n\nAnother alternative is to look into [Satis](https://github.com/composer/satis), bare git mirrors and repository aliasing.\n\nAnother way to speedup downloads over ssh (also interesting for satis users) is to improve your ssh configs.\nAt least for newer versions of openSSH you can add the following to your ```.ssh/config``` to reuse previous connections.\n```\nHost * \n    ControlPath ~/.ssh/controlmasters/%r@%h:%p\n    ControlMaster auto\n    ControlPersist 10m\n```\n\nalso you need to create the ```controlmasters``` directory:\n```sh\nmkdir ~/.ssh/controlmasters\nchmod go-xr ~/.ssh/controlmasters\n```\n\nfurther information can be found on [wikibooks](https://en.wikibooks.org/wiki/OpenSSH/Cookbook/Multiplexing) \n\n## Usage\n\n### Update the Installer\n\nas this is a composer plugin, you should only use these two commands to update the installer\n\n``` \ncomposer require --no-update  magento-hackathon/magento-composer-installer=\"3.2.*\"\ncomposer update --no-plugins --no-scripts magento-hackathon/magento-composer-installer\n```\n\nthe second command needs maybe a `--with-dependencies`  \nDepending on your workflow with composer, you may want to use more explicit versions\n\n### Install a module in your project\n\nmake sure to use [the public Magento module repository](https://packages.firegento.com) as composer repository:\n\n```composer config -g repositories.firegento composer https://packages.firegento.com```\n\nconfigure your `magento root dir`, the directory where your magento resides:  \n```composer config extra.magento-root-dir \"htdocs/\"```\n \nan example how your project ```composer.json``` could look like:\n\n```json\n{\n    \"repositories\": [\n        {\n            \"type\": \"composer\",\n            \"url\": \"https://packages.firegento.com\"\n        }\n    ],\n    \"extra\":{\n        \"magento-root-dir\": \"htdocs/\"\n    }\n}\n```\n\n### Auto add files to .gitignore\n\nIf 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:\n\n```json\n{\n    \"extra\":{\n        \"magento-root-dir\": \"htdocs/\",\n        \"auto-append-gitignore\": true\n    }\n}\n```\n\nThe `.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\ndescribing the module name for clarity.\n\nMultiple deploys will not add additional lines to your `.gitignore`, they will only ever be added once.\n\n\n### Adding Composer's autoloader to Magento\n\nDocumentation available [here](doc/Autoloading.md). \n\n### Overwriting a production setting (DevMode)\n\n```json\n{\n    \"extra\":{\n        \"magento-deploystrategy\": \"copy\",\n        \"magento-deploystrategy-dev\": \"symlink\"\n    }\n}\n```\n\nExample in [devmode doc](doc/DevMode.md).\n\n\n### Include your project in deployment\n\nWhen the magento-composer-installer is run, it only looks for magento-modules among your project's dependencies. Thus, if\nyour project is a magento-module and you want to test it, you will need a second `composer.json` for deployment, \nwhere your project is configured as a required package.\n\nIf you wish to deploy your project's files (a.k.a. root package), too, you need to setup your `composer.json` as follows:\n\n```\n{\n    \"type\": \"magento-module\",\n    ...\n    \"extra\": {\n        \"magento-root-dir\": \"htdocs/\",\n        \"include-root-package\": true\n    }\n}\n```\n\n### Testing\n\nFirst clone the magento-composer-installer, then install the dev-stuff (installed by default):\n\n```\n./bin/composer.phar install\n```\n\nthen run ```vendor/bin/phpunit``` in project-root directory.\n\nNote: Windows users please run ```phpunit``` with Administrator permissions.\n\n\n## Further Information\n\n* [FAQ](doc/FAQ.md)\n* [Make a Magento module installable with composer](doc/MakeAModuleInstallableWithComposer.md)\n* [About File Mapping like for example modman](doc/Mapping.md)\n* [About Deploying files into your Magento root and possible configs](doc/Deploy.md)\n\n### External Links\n\n* [Composer How to Screencast](http://www.youtube.com/watch?v=m_yprtQiFgk)\n* [Introducing Composer Blog on Magebase.com](http://magebase.com/magento-tutorials/composer-with-magento/)\n* [Magento, Composer and Symfonys Dependency Injection](http://www.piotrbelina.com/magento-composer-and-dependency-injection/)\n* [Using Composer for Magento(at engineyard)](https://blog.engineyard.com/2014/composer-for-magento)\n\n### Core Contributors\n\n* Daniel Fahlke aka Flyingmana (Maintainer)\n* Jörg Weller\n* Karl Spies\n* Tobias Vogt\n* David Fuhr\n* Amir Tchavoshinia\n* Vinai Kopp (Maintainer)\n\n## Thank You\n\nThere are a few companies we want to thank for supporting this project in one way or another.\n\n#####[digital.manufaktur GmbH](https://www.digitalmanufaktur.com/)\n\nTeached me (Flyingmana) most I know about Magento and\npaid my participation for the hackathon were the installer got created.\n\n#####[melovely](http://www.melovely.de/)\n\nSupport me (Flyingmana) as my current employer very much in my work on everything composer related.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCotya%2Fmagento-composer-installer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCotya%2Fmagento-composer-installer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCotya%2Fmagento-composer-installer/lists"}