mirror of
https://github.com/deployphp/deployer.git
synced 2025-02-23 16:54:08 +01:00
123 lines
4.3 KiB
Markdown
123 lines
4.3 KiB
Markdown
<!-- DO NOT EDIT THIS FILE! -->
|
||
<!-- Instead edit recipe/flow_framework.php -->
|
||
<!-- Then run bin/docgen -->
|
||
|
||
# How to Deploy a Flow Framework Project
|
||
|
||
```php
|
||
require 'recipe/flow_framework.php';
|
||
```
|
||
|
||
[Source](/recipe/flow_framework.php)
|
||
|
||
Deployer is a free and open source deployment tool written in PHP.
|
||
It helps you to deploy your Flow Framework 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 **Flow Framework** 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:run_migrations](/docs/recipe/flow_framework.md#deployrun_migrations) – Applies database migrations
|
||
* [deploy:publish_resources](/docs/recipe/flow_framework.md#deploypublish_resources) – Publishes resources
|
||
* [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 flow_framework recipe is based on the [common](/docs/recipe/common.md) recipe.
|
||
|
||
## Configuration
|
||
### flow_context
|
||
[Source](https://github.com/deployphp/deployer/blob/master/recipe/flow_framework.php#L9)
|
||
|
||
Flow-Framework application-context
|
||
|
||
```php title="Default value"
|
||
'Production'
|
||
```
|
||
|
||
|
||
### flow_command
|
||
[Source](https://github.com/deployphp/deployer/blob/master/recipe/flow_framework.php#L12)
|
||
|
||
Flow-Framework cli-command
|
||
|
||
```php title="Default value"
|
||
'flow'
|
||
```
|
||
|
||
|
||
### shared_dirs
|
||
[Source](https://github.com/deployphp/deployer/blob/master/recipe/flow_framework.php#L15)
|
||
|
||
Overrides [shared_dirs](/docs/recipe/deploy/shared.md#shared_dirs) from `recipe/deploy/shared.php`.
|
||
|
||
Flow-Framework shared directories
|
||
|
||
```php title="Default value"
|
||
[
|
||
'Data/Persistent',
|
||
'Data/Logs',
|
||
'Configuration/{{flow_context}}'
|
||
]
|
||
```
|
||
|
||
|
||
|
||
## Tasks
|
||
|
||
### deploy:run_migrations
|
||
[Source](https://github.com/deployphp/deployer/blob/master/recipe/flow_framework.php#L25)
|
||
|
||
Applies database migrations.
|
||
|
||
Apply database migrations
|
||
|
||
|
||
### deploy:publish_resources
|
||
[Source](https://github.com/deployphp/deployer/blob/master/recipe/flow_framework.php#L33)
|
||
|
||
Publishes resources.
|
||
|
||
Publish resources
|
||
|
||
|
||
### deploy
|
||
[Source](https://github.com/deployphp/deployer/blob/master/recipe/flow_framework.php#L41)
|
||
|
||
Deploys your project.
|
||
|
||
Main task
|
||
|
||
|
||
This task is group task which contains next tasks:
|
||
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
|
||
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
|
||
* [deploy:run_migrations](/docs/recipe/flow_framework.md#deployrun_migrations)
|
||
* [deploy:publish_resources](/docs/recipe/flow_framework.md#deploypublish_resources)
|
||
* [deploy:publish](/docs/recipe/common.md#deploypublish)
|
||
|
||
|