mirror of
https://github.com/deployphp/deployer.git
synced 2025-02-23 16:54:08 +01:00
88 lines
3.1 KiB
Markdown
88 lines
3.1 KiB
Markdown
<!-- DO NOT EDIT THIS FILE! -->
|
||
<!-- Instead edit recipe/sulu.php -->
|
||
<!-- Then run bin/docgen -->
|
||
|
||
# How to Deploy a Sulu Project
|
||
|
||
```php
|
||
require 'recipe/sulu.php';
|
||
```
|
||
|
||
[Source](/recipe/sulu.php)
|
||
|
||
Deployer is a free and open source deployment tool written in PHP.
|
||
It helps you to deploy your Sulu application to a server.
|
||
It is very easy to use and has a lot of features.
|
||
|
||
Three main features of Deployer are:
|
||
- **Provisioning** - provision your server for you.
|
||
- **Zero downtime deployment** - deploy your application without a downtime.
|
||
- **Rollbacks** - rollback your application to a previous version, if something goes wrong.
|
||
|
||
Additionally, Deployer has a lot of other features, like:
|
||
- **Easy to use** - Deployer is very easy to use. It has a simple and intuitive syntax.
|
||
- **Fast** - Deployer is very fast. It uses parallel connections to deploy your application.
|
||
- **Secure** - Deployer uses SSH to connect to your server.
|
||
- **Supports all major PHP frameworks** - Deployer supports all major PHP frameworks.
|
||
|
||
You can read more about Deployer in [Getting Started](/docs/getting-started.md).
|
||
|
||
The [deploy](#deploy) task of **Sulu** consists of:
|
||
* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release
|
||
* [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment
|
||
* [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy
|
||
* [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy
|
||
* [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release
|
||
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code
|
||
* [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs
|
||
* [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs
|
||
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors
|
||
* [deploy:cache:clear](/docs/recipe/symfony.md#deploycacheclear) – Clears cache
|
||
* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release
|
||
* [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release
|
||
* [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy
|
||
* [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases
|
||
* [deploy:success](/docs/recipe/common.md#deploysuccess) –
|
||
|
||
|
||
The sulu recipe is based on the [symfony](/docs/recipe/symfony.md) recipe.
|
||
|
||
## Configuration
|
||
### bin/websiteconsole
|
||
[Source](https://github.com/deployphp/deployer/blob/master/recipe/sulu.php#L12)
|
||
|
||
|
||
|
||
```php title="Default value"
|
||
return parse('{{bin/php}} {{release_or_current_path}}/bin/websiteconsole --no-interaction');
|
||
```
|
||
|
||
|
||
|
||
## Tasks
|
||
|
||
### phpcr:migrate
|
||
[Source](https://github.com/deployphp/deployer/blob/master/recipe/sulu.php#L17)
|
||
|
||
Migrates PHPCR.
|
||
|
||
|
||
|
||
|
||
### deploy:website:cache:clear
|
||
[Source](https://github.com/deployphp/deployer/blob/master/recipe/sulu.php#L22)
|
||
|
||
Clears cache.
|
||
|
||
|
||
|
||
|
||
### deploy:website:cache:warmup
|
||
[Source](https://github.com/deployphp/deployer/blob/master/recipe/sulu.php#L27)
|
||
|
||
Warmups cache.
|
||
|
||
|
||
|
||
|