This repository contains a deployer configuration for shopware.
Copy the contents of this repository to your shop project. Within your shop project download the latest composer.phar and deployer.phar to the bin directory.
Also download the latest cachetool.phar if you need to reset an OPCache.
The web directory will be used as shopware root directory. Place all custom files for your shopware project here, e.g. plugins and custom themes.
We recommend to use K10rProject for database migrations (via NetcomMigrations) and snippet management so this config depends on it. Please add it to your repository if you want to use it. However if you don't need it you will need to remove it from the plugin list in deploy.php and remove the command k10r:snippets:update in the task kellerkinder:shopware:config.
This file defines the different hosts you may want to deploy to. Adjust those hosts to your needs. See deployer documentation for further information.
This file defines the basic configuration via deployers set-method. Make sure to adjust the following options to your needs:
repository: URL to the repository you want to deploy.bin/php: Absolute path to the php executable on your server.bin/composer: Path to composer. Adjust if you do not want to use the composer.phar.shopware_download_path: URL to the shopware installation package you want to deploy.shopware_update_version: Shopware version you want to update to. Will be used to check wether the current installation needs to be updated.shopware_update_path: URL to shopware update package you want to update to.plugins: An array of plugins that will be installed and updated during deployment. Those plugins need to be present in the codebase.plugin_config: An array of plugin configuration settings that will be set during deployment.theme_config: An array of theme configuration settings that will be set during deployment.shopware_config: An array of shopware configuration settings that will be set during deployment.fcgi_sockets: An array of fcgi_sockets that will be used to reset the OPCache.
Wrapper task for the basic installations steps:
Downloads the defined shopware installation package, unpacks it and rsyncs it into the shopware root directory.
Requires some plugins via composer. In this example config those will be K10rStaging and K10rDeployment
Note: They will not be installed yet.
This task will check wether the currently installed shopware version matches the shopware_update_version (see above) and will download the shopware update package and update the shop if needed.
This tasks wraps several configuration steps:
This will reset the OPCache using cachetool.phar and the fcgi_sockets specified in the deploy.php
This will (re)install K10rDeployment which gives us some useful commands for the deployment process. Afterwards it deactivates SwagUpdate since we do not want anyone to install an update via backend.
And most importantly it installs and updates all plugins specified in the plugins variable in deploy.php.
This task will also configure plugins according to the plugin_config variable in deploy.php.
This step will import and update the snippets defined via K10rProject. It will also be used to set configurations that should be the same in all stages. Add your own configurations via shopware_config in deploy.php.
For more information on how to set configurations check K10rDeployment.
Clears the cache using sw:cache:clear and compiles the themes afterwards. Can also be used to warm up the cache which is not activated by default. It can be activated by setting warm_cache_after_deployment to true in the deploy.php.
These two commands are used to set configurations that differ between the stages.
The staging task will for example install and activate K10rStaging which will show a notice that the user is in a staging environment and catch mails.
This task also sets the shop name and title to DEV!!! via k10r:store:update. This is configurable in the deploy-hosts.yml.
These tasks are usually used to set plugin configurations differing between stage and production, e.g. PayPal in production or sandbox mode. Or to deactivate a tracking plugin that will only be used production.
Within your deploy path deployer will create several directories:
.dep: Information about the releasescurrent: Symlink that will always be linked to the latest release.releases: This directory contains the last 10 releases. If you want to keep more or less releases simply overwrite thekeep_releasessetting viadeploy.php.shared/media: Place your media files here. deployer will symlink them into the shopware root directory across all releases.shared/files: Same as above but for the document and download files.shared/web: Place yourconfig.phphere. Also a good place for the.htaccessif it's not identical to the one shippied with shopware.
The shared directories and files are configured in deploy-shopware.php. You can add more by using add in the deploy.php, e.g. add('shared_files', ['{{shopware_public_dir}}/.htaccess']);.
Since we use GitLab CI to manage our code and deploy the projects we also ship the .gitlab-ci.yml.example which will work perfectly together with this deployer config.
To get this to work you will need some configuration in GitLab:
- Create the SSH_PRIVATE_KEY variable in the GitLab project settings. This variable needs to contain the private SSH key with access to the server.
- Add the deployment key with the matching public SSH key.
- Add the public SSH key to the
.authorized_keysfile of the server.
Feel free to send pull requests if you have any optimizations. They will be highly appreciated.
MIT licensed, see LICENSE