简单轻松部署你的项目 - Deployer

deployer

本文主要介绍 Deployer —— 一个具有模块化、代码回滚、并行任务等功能的 PHP 部署工具。

Deployer 用法非常简单易用,可以快速上手,且支持多个 PHP 框架。

安装

Deployer 安装有多种方法:

第一种 通过 Phar 存档,只需运行一下命令即可:

curl -LO https://deployer.org/deployer.phar

mv deployer.phar /usr/local/bin/dep

chmod +x /usr/local/bin/dep

第二种 通过 composer 安装:

composer require deployer/deployer --dev

使用:

php vendor/bin/dep

第三种 通过 Github 源代码安装:

clone 最新的代码:

git clone https://github.com/deployphp/deployer.git

在源代码目录下运行:

php ./build

第三种方法会建立 deployer.phar 的 Phar 归档,所以建议使用第一种方法安装。

使用

安装完后,你可以通过 dep 使用 Deployer ,在你的项目目录下运行以下命令:

dep init

运行此命令后会出现下图的选项,可选择你所需的,当然本教程使用 Laravel ,so 选择 [1] Laravel

deployer-init

初始化后,会自动生成 deployer.php 文件。 deployer.php 文件包含了基本的部署配置和任务,且有明确的注释,你可以根据注释在适当的地方添加配置以及任务。

没错,按照 deployer.php 文件的注释,设置一下 repositoryserver config ,基本上都能正常运行。

如何快速入门使用?可以看看官方入门文档 https://deployer.org/docs/getting-started ,这里不一一列出。

当你第一次成功部署的时候, Deployer 会自动帮你在服务器上生成一下文件:

  • releases 包含你部署项目的版本(默认保留 5 个版本)
  • shared 包含你部署项目的共享文件或目录(如:LaravelStorage 目录、.env 文件等 )
  • current 软连接到你当前发布的版本

需要注意的地方: Deployer 默认使用 ACL 来设置权限,你可以设置 writable_mode 来改变这个行为。

自动部署

到了这里,恭喜你,已经可以愉快使用 Deployer 。但是又有一个问题,每次提交 push 一次代码后都要运行 dep deploy 才会部署,有木有觉得很麻烦,接下来就说一下自动部署,相信你也想一切自动化的吧。

需要做的工作:

生成 git 用户公钥和部署公钥 -> 设置用户公钥到你帐户相关联的 SSH Keys -> 设置部署公钥到你项目的 Deploy keys -> 准备 hook 文件 -> 在项目上添加一个 Webhook 并设置 hook 的网址

当然,你要在服务器上自动部署还需要在服务器上安装 deployer 并设置好部署配置,确保其能正常运行。当 push 代码后触发 webhook ,发送请求到服务器的 hook ,若验证成功则执行 dep deploy 命令。

自动部署的文章很多,也非常简单,基本上就是在 Git 代码仓库设置一下 webhook 然后在服务器配置一下就搞掂的事,我就不一一列出,因为做重复的事也没什么意义。

webhook 设置自动部署教程:

Laravist - Coding Webhook 自动部署 Git 项目

利用WebHook实现PHP自动部署Git代码

使用PHP脚本远程部署git项目

如果你想使用图形化界面的部署工具,你可以使用:Jenkinswalle - 瓦力部署 等等。

本文主要简单介绍一下 Deployer 以及使用 Deployer 自动部署如何去做,而不会做太过详细的教程,因为 Deployer 的文档已经写得很清晰易明,以及有各种设置 Webhook 的教程,所以我没有必要一一列出(因为我懒)。

最后的最后感谢 overtrue - 超哥

Nothing is impossible. —— @Jiajian Chan