使用Nginx在 Linux 上托管 ASP.NET Core 6.0应用：GitHub Actions自动部署 ...

使用Nginx在 Linux 上托管 ASP.NET Core 6.0应用：GitHub Actions自动部署

前言

本文主要参考微软这篇文档而来 Host ASP.NET Core on Linux with Nginx，并使用Github Actions做CI&CD，部署到阿里云服务器，所有步骤均亲测可用。
你需要有

• Linux云服务器（本文使用的是阿里云Ubantu 22.04 64位）
  
• SSH客户端（我使用的XShell, 官网 可以下载免费的家庭/学校版）
  
• Github账号以及能流畅访问^
  

项目准备

使用VS2022新建一个空的ASP.NET Core Web API项目，框架选择.Net 6.0。
因为需要使用Nginx，这里就简单配置中间件转发下 X-Forwarded-For 和 X-Forwarded-Proto 两个header。

1. using Microsoft.AspNetCore.HttpOverrides;
3. ...
5. app.UseForwardedHeaders(new ForwardedHeadersOptions
6. {
7.     ForwardedHeaders = ForwardedHeaders.XForwardedFor | ForwardedHeaders.XForwardedProto
8. });
10. app.UseAuthentication();

复制代码

本地启动一下，看到swagger页面，没什么问题。代码提交Github，接下来开始配置服务器.
服务器配置

所有包均使用 apt 命令进行安装，如果安装过程提示 Unable to locate package 错误，请先执行如下命令后，再重新安装。

1. sudo apt update

复制代码

安装ASP.Net Core运行时

由于我们是部署应用，只需在服务器上安装运行时即可，无需安装.net sdk

1. sudo apt install -y aspnetcore-runtime-6.0

复制代码

查看是否安装成功：

1. dotnet --info

复制代码

安装配置 Nginx

安装Nginx

1. sudo apt install nginx

复制代码

编辑Nginx配置文件

1. vim /etc/nginx/sites-available/default

复制代码

Esc进入命令模式，gg跳至首行，然后dG，清空当前配置，复制粘贴下面的配置。

1. server {
2.     listen        80;
3.     server_name   example.com *.example.com;
4.     location / {
5.         proxy_pass         http://127.0.0.1:5000;
6.         proxy_http_version 1.1;
7.         proxy_set_header   Upgrade $http_upgrade;
8.         proxy_set_header   Connection keep-alive;
9.         proxy_set_header   Host $host;
10.         proxy_cache_bypass $http_upgrade;
11.         proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
12.         proxy_set_header   X-Forwarded-Proto $scheme;
13.     }
14. }

复制代码

退出并且保存 (Esc + :wq ，然后回车）
测试配置是否正确：

1. sudo nginx -t

复制代码

没问题之后，让Nginx重新加载配置

1. sudo nginx -s reload

复制代码

用户及权限

创建一个账号等下给Github Actions使用，总不能给它用root账号

1. sudo adduser github

复制代码

创建一个文件夹，后面发布后的文件就上传到这里

1. sudo mkdir -p /home/project/example

复制代码

给新账号添加该文件夹的读写权限

1. sudo chown -R github /home/project/example

复制代码

到这里其实可以手动上传发布文件到服务器测试一下，但是为了省时间还是跳过，直接用Github Actions来发布。
Github Actions 配置

打开Github仓库，选择如下官方提供的.NET工作流进入编辑页面

使用如下配置：

1. name: ASP.NET Core 6.0 Example build and deploy
2.   
3. on:
4.   push:
5.     branches: [ "main" ]
6.   pull_request:
7.     branches: [ "main" ]
9. jobs:
11.   build:
12.     runs-on: ubuntu-latest
14.     steps:
15.     - uses: actions/checkout@v3
16.     - name: Setup .NET
17.       uses: actions/setup-dotnet@v2
18.       with:
19.         dotnet-version: 6.0.x
20.         
21.     - name: Restore dependencies
22.       run: dotnet restore
23.       
24.     - name: Build package
25.       run: dotnet publish ./src/example -c Release -r linux-x64 --self-contained false -o deploy
26.       
27.     - name: Upload package
28.       uses: garygrossgarten/github-action-scp@v0.7.3
29.       with:
30.         host: ${{ secrets.REMOTE_HOST }}
31.         username: ${{ secrets.REMOTE_USER }}
32.         password: ${{ secrets.REMOTE_PWD }}
33.         port: 22
34.         local: /home/runner/work/playground/example/deploy/
35.         remote: "/home/project/example/"

复制代码

当main分支有提交或者PR时，发布就会触发；还有几个需要说明的地方，

• 关于打包，这里指定了 --self-contained false，是为了减少发布的dll文件，更多publish命令，可以参考 .NET application publishing overview
  
• 你可能已经注意到yml文件有很多secrets参数，这是在仓库如下处进行配置
  
  
• REMOTE_HOST是服务器地址，REMOTE_USER就是上面新创建的账号github，我这里使用的是 garygrossgarten/github-action-scp SSH上传文件到服务器，更多用法说明，直接参考文档。
  

提交yml文件，打开Actions，查看执行情况，可以看到已经完成了

检查下服务器是不是已经有发布文件了

1. cd /home/project/example
2. ls -l

复制代码

手动运行一下，

1. dotnet example.dll

复制代码

可以看到，外网已经可以访问了

如果不能访问，在阿里云控制台检查安全组规则，是否添加了80端口。

如果还是不能访问，检查一下服务器的防火墙，将80端口添加进去。

1. ufw status
2. ufw allow 80

复制代码

systemd 守护进程

为了让服务在崩溃或者服务器重启之后，也能重新运行，这里使用systemd来管理我们的服务。
创建服务定义文件：

1. sudo nano /etc/systemd/system/dotnet-example.service

复制代码

使用如下配置，Ctrl + X 退出保存。

1. [Service]
2. WorkingDirectory=/home/project/example
3. ExecStart=/usr/bin/dotnet /home/project/example/example.dll
4. Restart=always
5. # Restart service after 5 seconds if the dotnet service crashes:
6. RestartSec=5
7. KillSignal=SIGINT
8. SyslogIdentifier=dotnet-example
9. User=root
10. Environment=ASPNETCORE_ENVIRONMENT=Production
11. Environment=DOTNET_PRINT_TELEMETRY_MESSAGE=false
12. [Install]
13. WantedBy=multi-user.target

复制代码

服务启用、启动、查看状态：

1. sudo systemctl daemon-reload
2. sudo systemctl enable dotnet-example.service
3. sudo systemctl start dotnet-example.service
4. sudo systemctl status dotnet-example.service

复制代码

最后更新Github Actions,将如下配置添加到末尾，这里使用的是同一个人的另一个项目来执行远程命令 garygrossgarten/github-action-ssh

1.     - name: Restart dotnet-example.service
2.       uses: garygrossgarten/github-action-ssh@v0.6.3
3.       with:
4.         command: sudo systemctl restart dotnet-example.service; cd /home/project/example; ls -l
5.         host: ${{ secrets.REMOTE_HOST }}
6.         username: ${{ secrets.REMOTE_USER }}
7.         password: ${{ secrets.REMOTE_PWD }}

复制代码

配置生效，发布成功：

总结

本文完整介绍了如何使用Github Actions做CI&CD（感叹一下，免费的Github Actions太良心了，很方便个人项目或者私活，你完全可以只准备应用服务器），将ASP.NET Core 6.0 程序部署到阿里云Ubantu服务器，并使用Nginx作为web服务器，systemd做守护进程。虽然现在k8s已经很普及，并且很多公司都基本有专门DevOps团队维护CI&CD，程序员只需专注业务代码开发。但是了解并实操一遍整个过程还是很有益处的，特别是对新手。很多未知的坑，实践之前你永远不知道；就像以前也不知道写博客还挺累（整个搭建流  程前前后后完整重复了三遍，服务器都重置了好几回^）
任何问题或者建议，欢迎评论区留言讨论~

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！