deployer/docs/recipe/magento.md

95 lines
2.5 KiB
Markdown
Raw Normal View History

2021-09-26 15:25:58 +02:00
<!-- DO NOT EDIT THIS FILE! -->
<!-- Instead edit recipe/magento.php -->
<!-- Then run bin/docgen -->
2022-07-26 00:12:23 +02:00
# How to Deploy Magento
2021-09-26 15:25:58 +02:00
[Source](/recipe/magento.php)
2022-07-26 00:12:23 +02:00
## How to deploy a Magento project with zero downtime?
2022-07-26 00:19:14 +02:00
- First, [install](/docs/installation.md) the Deployer.
- Second, require `recipe/magento.php` recipe into your _deploy.php_ or _deploy.yaml_ file.
- Third, and now you can have a zero downtime deployment!
2022-07-26 00:12:23 +02:00
Did you know that you can deploy **Magento** project with a single command? Just execute `dep deploy`.
2022-07-26 00:19:14 +02:00
Something went wrong? Just run `dep rollback` to rollback your changes.
2022-07-26 00:12:23 +02:00
Also, you can take an advantages of the [Deployer's CLI](/docs/cli.md) to deploy your project.
2022-07-26 00:19:14 +02:00
Another feature of the Deployer is [provisioning](/docs/recipe/provision.md). Take any server, and run `dep provision` command.
2022-07-26 00:12:23 +02:00
This command will configure webserver, databases, php, ssl certificates, and more.
You will get everything you need to run your **Magento** project.
2022-07-26 00:19:14 +02:00
The magento recipe is based on the [common](/docs/recipe/common.md) recipe.
2021-09-26 15:25:58 +02:00
## Configuration
### shared_dirs
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento.php#L13)
2021-10-18 18:29:14 +02:00
Overrides [shared_dirs](/docs/recipe/deploy/shared.md#shared_dirs) from `recipe/deploy/shared.php`.
2021-09-26 15:25:58 +02:00
Magento shared dirs
```php title="Default value"
['var', 'media']
```
### shared_files
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento.php#L16)
2021-10-18 18:29:14 +02:00
Overrides [shared_files](/docs/recipe/deploy/shared.md#shared_files) from `recipe/deploy/shared.php`.
2021-09-26 15:25:58 +02:00
Magento shared files
```php title="Default value"
['app/etc/local.xml']
```
### writable_dirs
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento.php#L19)
Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`.
Magento writable dirs
```php title="Default value"
['var', 'media']
```
## Tasks
### deploy:cache:clear
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento.php#L25)
2021-11-08 22:59:39 +01:00
Clears cache.
2021-09-26 15:25:58 +02:00
Clear cache
### deploy:clear_version
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento.php#L32)
2021-09-26 15:43:51 +02:00
2021-09-26 15:25:58 +02:00
Remove files that can be used to compromise Magento
### deploy
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento.php#L46)
2021-11-08 22:59:39 +01:00
Deploys your project.
2021-09-26 15:25:58 +02:00
Main task
This task is group task which contains next tasks:
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:cache:clear](/docs/recipe/magento.md#deploycacheclear)
* [deploy:publish](/docs/recipe/common.md#deploypublish)