Skip to content

服务器自动部署

钩子实现自动化部署

第一步:创建 git 用户

登录服务器,这里默认你已经安装好了 git。创建一个 git 用户:

bash
# 创建一个名叫jouzeyu的用户
adduser jouzeyu

第二步:给 git 用户添加权限

bash
# 在根目录下的 home 文件夹下创建一个git文件夹
mkdir /home/git
# 切换到创建好的git文件夹
cd /home/git
# 创建 .ssh文件夹,里面主要用来放公钥
mkdir .ssh
# 切换到.ssh文件夹并创建authorized_keys文件
cd .ssh
touch authorized_keys

第三步:配置 git 并获取公钥

bash
# 在本地配置用户名和邮箱,我的用户名默认为jouzeyu
git config --global user.name "jouzeyu"
git config --global user.email "your email"

注意:如果用了 --global 选项,那么以后你所有的项目都会使用这里配置的用户信息。如果要在某个特定的项目中使用其他名字或邮箱,只需在该项目下执行:

php
git config user.name "xxx"
git config user.email "xxx"

接下来我们获取公钥,请先查看你的用户下的.ssh 文件夹中是否之前就含有公钥和私钥,我们需要寻找一对以 id_dsa 或 id_rsa 命名的文件,其中一个带有 .pub 扩展名。.pub 文件是你的公钥,另一个则是私钥。如果没有请运行 ssh-keygen。

使用 cat ~/.ssh/id_rsa.pub 命令可以获取公钥,复制它,使用 vi 或者 vim 命令把它粘贴到我们之前创建的 authorized_keys 文件中,使用:wq 保存。

第四步:初始化仓库

创建一个存放 git 仓库的文件夹:

bash
mkdir /www/wwwroot/git
cd /www/wwwroot/git

初始化仓库:

bash
# 初始化一个裸仓库(强烈建议)
git init --bare website.git
# 配置仓库的权限,让我们之前创建好的git用户jouzeyu能读写
chown -R git:git website.git

这里必须注意,如果不给权限,后面的 git pull 将会报错,原因是没有权限写入。关于裸仓库和普通仓库的区别简单来说就是裸仓库看不到项目文件,普通仓库和你的项目目录一样,只是多了一个.git 文件夹。

第五步:生成项目仓库

这个也是在服务器上进行的,同时说明一下/www/wwwroot/是我的环境的根目录。

php
# 创建我服务器上的项目目录test
mkdir /www/wwwroot/test
# 克隆仓库
git clone /www/wwwroot/git/website.git
# 设置权限
chown -R git website

注意:一定要注意我的路径,git 仓库是 /www/wwwroot/git, 项目仓库是 /www/wwwroot/test。

第六步:克隆到本地

php
# 通过ip地址从配置好的线上仓库拉取下来
git clone git@47.97.121.XXX:/www/wwwroot/git/website.git
# 如果有配置域名的话也可以通过域名拉取
git clone git@www.XXX.XXX:/www/wwwroot/git/website.git

因为公钥的原因,这里是不需要密码的,如果成功你的电脑上会出现一个 website 的文件夹,如果报错请检查后再进行下面的操作。

第七步:上传代码(git push)

php
# 打开刚才克隆下来的本地仓库
cd website
# 创建README.md文件
touch README.md
git add .
git commit -m"创建README.md文件"
git push

不出意外已经正常上传了,如果报错请检查权限,上文提到过,如果还不行可以在下方评论。

第八步:添加钩子

写的比较细,现在才来讲钩子,回到我们线上的服务器,下面的是在线上操作的:

php
# 切换到这个目录
cd /www/wwwroot/git/website.git/hooks
# 生成post-receive文件
touch post-receive
# 使用vim编辑
vim post-receive

在 post-receive 文件里面粘贴:

php
#!/bin/sh
# 打印输出
echo '======上传代码到服务器======'
# 打开线上项目文件夹
cd /www/wwwroot/test/website
# 这个很重要,如果不取消的话将不能在cd的路径上进行git操作
unset GIT_DIR
git pull origin master
# 自动编译vue项目,如有需要请去掉前面的#号
# npm run build
# 自动更新composer(我暂时没试过)
# composer update
echo $(date) >> hook.log
echo '======代码更新完成======'

保存后给 post-receive 文件加上运行权限

text
chmod +x post-receive

最后一步

在本地修改部分内容,然后提交推送 git push,可以看到我们已经实现了自动化部署。

SSH 连接部署

一、使用 SSH 链接 GitHub

  • 1.为了让 GitHub 仓库可以访问您的服务器,您需要在服务器上生成 SSH 公钥,并将其添加到 GitHub 账户的 SSH 密钥设置中。
  • 2.可以使用 ssh-keygen 命令在服务器上生成 SSH 公钥,然后使用 cat ~/.ssh/id_rsa.pub 命令查看并复制公钥。
  • 3.可以登录 GitHub 账户,进入 Settings -> SSH and GPG keys,点击 New SSH key,将复制的公钥粘贴到 Key 输入框中,点击 Add SSH key 完成添加

二、自动部署流程

  • 1.为了实现自动部署,您需要在 GitHub 仓库中设置一个 WebHook,当代码被推送到仓库中时,触发一个 POST 请求,通知服务器拉取最新的代码。
  • 2.可以登录 GitHub 账户,进入仓库的 Settings -> Webhooks,点击 Add webhook,输入服务器的 URL(例如 http://47.97.121.XXX:8080/webhook),选择 Content type 为 application/json,选择触发事件为 push events,点击 Add webhook 完成设置。
  • 3.需要在服务器上编写一个接收 POST 请求的脚本,例如 webhook.php,用于执行 git pull 命令,将最新的代码拉取到服务器的项目目录中。
  • 4.还需要在服务器上配置一个 web 服务器,例如 Nginx,用于监听 8080 端口,将请求转发到 webhook.php 脚本。

三、使用 SSH 链接阿里云服务器

  • 为了让本地电脑可以访问阿里云服务器,需要在阿里云控制台中设置安全组规则,开放 22 端口,允许 SSH 连接。
  • 您可以使用 XShell 等工具,输入阿里云服务器的 IP 地址,用户名,密码,进行 SSH 连接。
  • 也可以在本地电脑上生成 SSH 公钥,并将其添加到阿里云服务器的 ~/.ssh/authorized_keys 文件中,实现免密登录

四、手动部署

  • 如果不想使用自动部署,也可以手动部署项目,需要在本地电脑上使用 git push 命令,将代码推送到 GitHub 仓库。
  • 然后,需要在阿里云服务器上使用 git pull 命令,将代码拉取到服务器的项目目录中。
  • 可能还需要在服务器上执行一些其他的命令,例如 npm install,npm run build,composer update 等,根据项目需求进行安装依赖,打包构建,更新框架等操作。

五、自动部署

  • 如果使用了自动部署,只需要在本地电脑上使用 git push 命令,将代码推送到 GitHub 仓库,就可以触发自动部署的流程。
  • 不需要在阿里云服务器上执行任何命令,服务器会自动接收到 GitHub 的通知,拉取最新的代码,并执行相应的脚本。
  • 可以在 GitHub 仓库的 Webhooks 页面,查看自动部署的状态,是否成功,是否有错误。
  • 也可以在服务器上查看 webhook.php 脚本的日志,查看自动部署的细节,是否有异常。

Released under the MIT License.