{"id":19664597,"url":"https://github.com/sourcebroker/deployer-extended-magento2","last_synced_at":"2026-03-15T23:04:02.449Z","repository":{"id":57056074,"uuid":"95473120","full_name":"sourcebroker/deployer-extended-magento2","owner":"sourcebroker","description":"Deployer based deployment for Magento2 with media and database synchronisation.","archived":false,"fork":false,"pushed_at":"2022-01-26T11:49:45.000Z","size":32,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-05T11:23:11.861Z","etag":null,"topics":["deploy","deployer","deployer-recipes","deployment","magento2","sb-dem2"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sourcebroker.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-26T17:46:17.000Z","updated_at":"2022-01-26T11:49:48.000Z","dependencies_parsed_at":"2022-08-24T06:01:02.474Z","dependency_job_id":null,"html_url":"https://github.com/sourcebroker/deployer-extended-magento2","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcebroker%2Fdeployer-extended-magento2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcebroker%2Fdeployer-extended-magento2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcebroker%2Fdeployer-extended-magento2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcebroker%2Fdeployer-extended-magento2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sourcebroker","download_url":"https://codeload.github.com/sourcebroker/deployer-extended-magento2/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251391392,"owners_count":21582161,"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":["deploy","deployer","deployer-recipes","deployment","magento2","sb-dem2"],"created_at":"2024-11-11T16:18:18.304Z","updated_at":"2026-03-15T23:03:57.407Z","avatar_url":"https://github.com/sourcebroker.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"deployer-extended-magento2\n==========================\n\n.. contents:: :local:\n\nWhat does it do?\n----------------\n\nThis package provides deploy task for deploying Magento2 with deployer (deployer.org) and additionally a tasks\nto synchronize database and media files.\n\nDependencies\n------------\n\nThis package depends on following packages:\n\n- | `sourcebroker/deployer-extended`_\n  | Package which provides some deployer tasks that can be used for any framework or CMS.\n\n- | `sourcebroker/deployer-extended-database`_\n  | Package which provides some php framework independent deployer tasks to synchronize database.\n\n- | `sourcebroker/deployer-extended-media`_\n  | Package which provides some php framework independent deployer tasks to synchronize media.\n\n\nInstallation\n------------\n\n1) Install package with composer:\n   ::\n\n      composer require sourcebroker/deployer-extended-magento2\n\n   Note! This command will install also deployer/dist package which will create ./vendor/bin/dep binary. You should use\n   this binary to run deploy. Its advisable that you put `alias dep=\"php ./vendor/bin/dep\"` in your ~/.profile\n   to be able to run deployer with regular \"dep\" command.\n\n2) If you are using deployer as composer package then just put following line in your deploy.php:\n   ::\n\n      new \\SourceBroker\\DeployerExtendedMagento2\\Loader();\n\n3) If you are using deployer as phar then put following lines in your deploy.php:\n   ::\n\n      require_once(__DIR__ . '/vendor/sourcebroker/deployer-loader/autoload.php');\n      new \\SourceBroker\\DeployerExtendedMagento2\\Loader();\n\n4) Remove task \"deploy\" from your deploy.php. Otherwise you will overwrite deploy task defined in\n   deployer/deploy/task/deploy.php\n\n5) Example deploy.php file for phar based deployer:\n   ::\n\n    \u003c?php\n\n    namespace Deployer;\n\n    require_once(__DIR__ . '/vendor/sourcebroker/deployer-loader/autoload.php');\n    new \\SourceBroker\\DeployerExtendedMagento2\\Loader();\n\n    set('repository', 'git@my-git:my-project.git');\n\n    host('live')\n        -\u003ehostname('111.111.111.111')\n        -\u003euser('www-data')\n        -\u003eset('public_urls', ['http://www.example.com/'])\n        -\u003eset('deploy_path', '/var/www/example.com.live');\n\n    host('beta')\n        -\u003ehostname('111.111.111.111')\n        -\u003euser('www-data')\n        -\u003eset('public_urls', ['http://beta.example.com/'])\n        -\u003eset('deploy_path', '/var/www/example.com.beta');\n\n    host('local')\n        -\u003eset('public_urls', ['http://example-com.ddev.site/'])\n        -\u003eset('deploy_path', getcwd());\n\n\nMind the declaration of host('local'); Its needed for database tasks to declare domain replacements,\nand path to store database dumps.\n\n\nSpecial tasks for Magento2\n-------------------------\n\nmagento:deploy:git_checkout\n+++++++++++++++++++++++++++\n\nIf we install Magento2 with composer then we have some files in pub/ folder like '.htaccess' or 'index.php' which we\nsometimes want to change. Unfortunately during composer install, which is step after cloning repo, the pub/ files will\nbe overwritten with files from vendor/magento/magento2-base.\n\nThis task allows to do checkout for for files/folders defined in param 'git_checkout_items'. So if you have changes in\npub/.htaccess it will be reverted. By default the 'git_checkout_items' param has item 'pub/.htaccess'.\n\n\n.. _sourcebroker/deployer-extended: https://github.com/sourcebroker/deployer-extended\n.. _sourcebroker/deployer-extended-media: https://github.com/sourcebroker/deployer-extended-media\n.. _sourcebroker/deployer-extended-database: https://github.com/sourcebroker/deployer-extended-database\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsourcebroker%2Fdeployer-extended-magento2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsourcebroker%2Fdeployer-extended-magento2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsourcebroker%2Fdeployer-extended-magento2/lists"}