Deployer 使用教程

项目介绍

Deployer 是一个基于 PHP 的部署工具，旨在简化 PHP 项目的部署流程。它支持多种流行的 PHP 框架，如 Laravel、Symfony 等，并提供了丰富的功能，如零停机部署、自动回滚、服务器配置等。Deployer 通过 SSH 协议与服务器通信，执行预定义的操作，从而实现项目的自动化部署。

项目快速启动

安装 Deployer

首先，确保你已经安装了 Composer。然后，通过 Composer 全局安装 Deployer：

composer global require deployer/deployer

安装完成后，你可以通过以下命令检查 Deployer 是否安装成功：

dep --version

初始化项目

进入你的项目目录，并初始化 Deployer 配置文件：

cd /path/to/your/project
dep init

在初始化过程中，Deployer 会提示你选择项目类型。根据你的项目选择合适的类型，如 Laravel、Symfony 等。完成后，会在项目根目录生成一个 deploy.php 文件。

配置部署任务

编辑 deploy.php 文件，配置你的部署任务。以下是一个简单的示例配置：

<?php
namespace Deployer;

require 'recipe/laravel.php';

// 设置代码仓库地址
set('repository', '[e-mail]:yourusername/yourrepository.git');

// 定义服务器
host('your_server_ip')
    ->user('deployer')
    ->identityFile('~/.ssh/deployerkey')
    ->set('deploy_path', '/var/www/yourproject');

// 定义任务
task('deploy', [
    'deploy:info',
    'deploy:prepare',
    'deploy:lock',
    'deploy:release',
    'deploy:update_code',
    'deploy:shared',
    'deploy:vendors',
    'deploy:writable',
    'artisan:storage:link',
    'artisan:view:clear',
    'artisan:cache:clear',
    'artisan:config:cache',
    'artisan:optimize',
    'deploy:symlink',
    'deploy:unlock',
    'cleanup',
]);

after('deploy:failed', 'deploy:unlock');

执行部署

配置完成后，执行以下命令开始部署：

dep deploy -vvv

应用案例和最佳实践

应用案例

Deployer 广泛应用于 PHP 项目的自动化部署，特别是在需要频繁更新的 Web 应用中。例如，一个基于 Laravel 的电商网站，可以通过 Deployer 实现零停机部署，确保用户在更新过程中不会受到影响。

最佳实践

1. 权限管理：确保部署用户（如 deployer）具有足够的权限执行部署任务，同时避免使用 root 用户。
2. 版本控制：在部署前，确保代码已经提交到版本控制系统（如 Git），并推送到远程仓库。
3. 日志记录：在部署过程中，记录详细的日志信息，便于排查问题。
4. 回滚机制：配置自动回滚功能，确保在部署失败时能够快速恢复到上一个稳定版本。

典型生态项目

1. Laravel

Deployer 提供了针对 Laravel 框架的专用配置文件，简化了 Laravel 项目的部署流程。通过 require 'recipe/laravel.php'; 可以快速集成 Laravel 的部署任务。

2. Symfony

对于 Symfony 项目，Deployer 同样提供了专门的配置文件，支持 Symfony 的部署需求。通过 require 'recipe/symfony.php'; 可以轻松配置 Symfony 项目的部署任务。

3. Composer

Deployer 与 Composer 紧密集成，可以在部署过程中自动执行 composer install，确保项目依赖的包能够正确安装。

4. GitHub Actions

Deployer 可以与 GitHub Actions 结合使用，实现持续集成和持续部署（CI/CD）。通过配置 GitHub Actions 工作流，可以在代码推送到仓库后自动触发 Deployer 部署任务。

通过以上步骤，你可以快速上手 Deployer，并将其应用于你的 PHP 项目中，实现高效的自动化部署。