{"id":13782336,"url":"https://github.com/AOEpeople/magento-deployscripts","last_synced_at":"2025-05-11T15:32:25.512Z","repository":{"id":23461869,"uuid":"26825941","full_name":"AOEpeople/magento-deployscripts","owner":"AOEpeople","description":null,"archived":false,"fork":false,"pushed_at":"2017-04-05T17:26:21.000Z","size":14247,"stargazers_count":69,"open_issues_count":2,"forks_count":22,"subscribers_count":45,"default_branch":"master","last_synced_at":"2025-04-27T10:48:36.276Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AOEpeople.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2014-11-18T19:23:57.000Z","updated_at":"2023-11-16T21:29:34.000Z","dependencies_parsed_at":"2022-08-21T23:50:57.021Z","dependency_job_id":null,"html_url":"https://github.com/AOEpeople/magento-deployscripts","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AOEpeople%2Fmagento-deployscripts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AOEpeople%2Fmagento-deployscripts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AOEpeople%2Fmagento-deployscripts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AOEpeople%2Fmagento-deployscripts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AOEpeople","download_url":"https://codeload.github.com/AOEpeople/magento-deployscripts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253588698,"owners_count":21932309,"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":[],"created_at":"2024-08-03T18:01:35.407Z","updated_at":"2025-05-11T15:32:23.489Z","avatar_url":"https://github.com/AOEpeople.png","language":"Shell","funding_links":[],"categories":["Deployments"],"sub_categories":["Full Page Caching"],"readme":"Magento Deployment Scripts\n==========================\n\nAuthor: Fabrizio Branca\n\nThis is a collection of scripts used to build/package, deploy and install Magento projects.\n\n*Import note:*\nNever use the master branch in your build jobs. Instead clone a specific tag:\n```\ngit clone -b v1.0.0 https://github.com/AOEpeople/magento-deployscripts.git\n```\nSince these scripts might change significantly and your deployment process might fail otherwise.\n\n### Overview\n\n* [build.sh](#buildsh)\n* [deploy.sh](#deploysh)\n* [install.sh](#installsh)\n\n### Usage\n\nAdd the magento-deployment scripts to your project using Composer. Checkout composer.json example file below.\n\n### Introduction\n\n#### build vs. provisioning vs. deployment vs. installation\n\nCheckout http://www.slideshare.net/aoepeople/rock-solid-magento/91 (and the next slides after that)\n\nTODO: add more information here\n\n### \u003ca name=\"buildsh\"\u003e\u003c/a\u003ebuild.sh\n\n```\nUsage:\n ./deploy.sh -r \u003cpackageUrl\u003e -t \u003ctargetDir\u003e -e \u003cenvironment\u003e [-u \u003cdownloadUsername\u003e] [-p \u003cdownloadPassword\u003e] [-a \u003cawsCliProfile\u003e] [-d]\n -r     Package url (http, S3 or local file)\n -t     Target dir\n -u     Download username\n -p     Download password\n -a     aws cli profile (defaults to 'default')\n -d     Also download and install .extra.tar.gz package\n```\n\nGenerated files\n* projectName.tar.gz\n* projectName.extra.tar.gz\n* MD5SUMS\n\n#### Base package vs extra package\n\nCheckout http://www.slideshare.net/aoepeople/rock-solid-magento/55 (and the next slides after that)\n\n\u003ca name=\"tarexcludes\"\u003e\u003c/a\u003eExample Configuration/tar_excludes.txt content\n\n```\n.git*\n./htdocs/install.php\n./htdocs/includes\n./htdocs/downloader\n./htdocs/pkginfo\n./htdocs/LICENSE*\n./htdocs/RELEASE_NOTES.txt\n./htdocs/phpunit.xml*\n./htdocs/*.sample\n./htdocs/var\n./htdocs/media\n./tools/composer.phar\n./.modman/Aoe_TemplateHints\n./.modman/EcomDev_PHPUnit\n```\n\n#### Expected project files/directories\n\n* composer.json\n* tools/composer.phar (This should be part of your project repo. Obviously this can't be pulled in via Composer. Chicken and egg, problem... :)\n* tools/modman (This is part of https://github.com/AOEpeople/magento-deployscripts which is being pulled in via composer)\n* htdocs/index.php\n* .modman directory: The modules located here can be directly committed to the main project repository (e.g. if they're project specific) or they can be pulled in via Composer)\n* .modman/ProjectName_Base: There's no exclipict check for this base module to be present, but this is a recommendation. Add the basic project setup (local.xml, htaccess,...) to this base module.\n* .modman/.basedir\n* [Configuration/tar_excludes.txt](#tarexcludes) (this file controls what goes in the base package and what goes in the extra package. See below)\n\nAdditionally install.sh expects/checks these files:\n\n* tools/systemstorage_import.sh (This is part of https://github.com/AOEpeople/magento-deployscripts which is being pulled in via composer)\n* tools/apply (This is part of https://github.com/AOEpeople/EnvSettingsTool which is being pulled in via composer)\n* tools/n98-magerun.phar (This is part of https://github.com/AOEpeople/magento-deployscripts which is being pulled in via composer)\n* Configuration/settings.csv (This is being used by EnvSettingsTool to apply all environment specific settings during the installation process)\n* Configuration/mastersystem.txt (Defines which system is the master system. E.g. \"production\". This is required to determine if the systemstorage backup needs to be imported during the installation process.)\n* Configuration/project.txt (project name. E.g. \"acme\")\n\nThese files and folders can easily be constructud by using following composer.json as a basis for your project\n\n```\n{\n    \"name\": \"my/project\",\n    \"minimum-stability\": \"dev\",\n    \"require\": {\n        \"aoepeople/composer-installers\": \"*\",\n        \"aoepeople/envsettingstool\": \"*\",\n        \"tmp/magento_community\": \"1.9.0.1\"\n        \"aoepeople/magento-deployscripts\": \"1.0.3\"\n    },\n    \"repositories\": [\n        {\n            \"type\": \"vcs\",\n            \"url\": \"https://github.com/AOEpeople/composer-installers.git\"\n        },\n        {\n            \"type\": \"vcs\",\n            \"url\": \"https://github.com/AOEpeople/EnvSettingsTool.git\"\n        },\n        {\n            \"type\": \"package\",\n            \"package\": {\n                \"name\": \"tmp/magento_community\",\n                \"type\": \"magento-source\",\n                \"version\": \"1.9.0.1\",\n                \"dist\": {\n                    \"url\": \"https://github.com/OpenMage/magento-mirror/archive/1.9.0.1.zip\",\n                    \"type\": \"zip\"\n                }\n            }\n        },\n        {\n            \"type\": \"vcs\",\n            \"url\": \"https://github.com/AOEpeople/magento-deployscripts.git\"\n        }\n    ],\n    \"config\" : {\n        \"bin-dir\": \"tools\"\n    }\n}\n```\n\n#### Auto-generated meta files\n\nFollowing files will be stored inside the base package\n\n* build.txt\n* htdocs/version.txt (will be accessible from the web)\n\n### \u003ca name=\"deploysh\"\u003e\u003c/a\u003edeploy.sh\n\n### \u003ca name=\"installsh\"\u003e\u003c/a\u003einstall.sh\n\n### opsworks_*.sh\n\n### systemstorage_import.sh\n\n### *lint.sh\n\n### Tools\n\n#### n98-magerun\n#### modman\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAOEpeople%2Fmagento-deployscripts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAOEpeople%2Fmagento-deployscripts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAOEpeople%2Fmagento-deployscripts/lists"}