上传readme

README.md

@@ -1,6 +1,27 @@
 # 施工图审查系统二维码短链生成服务
-## 开发环境搭建
+## 开发环境
-1. 安装vs 2019
+- visual studio 2019
-2. 安装.net 5 SDK
+- dotnet5 sdk
-3. 安装docker desktop
+## 项目说明
-## 启动项目
+- 授权与鉴权中间件 `CheckSignMiddleware`  
+  需要鉴权的接口通过请求中的appid,time计算出签名和请求带来的sign比较  
+- 获取二维码 `LinkController.Create`
+  返回短链地址
+- 从短链地址重定向到实际网址 `RedirectController.Index`  
+  从数据库中获取实际地址并带上校验参数 浏览器重定向到目标地址
+## 发布说明
+- 部署在Linux系统中 以守护进程方式运行  
+  文档: [netcore and systemd](https://devblogs.microsoft.com/dotnet/net-core-and-systemd/)
+- 服务器信息
+  - ip地址:10.19.94.213 系统版本 ubuntu 
+  - 守护程序配置文件 `/etc/systemd/system/qrcode.service`
+  - 项目发布主程序入口 `/home/kuanyi/git/sgt_qrcode/QRCodeService/bin/Debug/net5.0/QRCodeService`
+  - 工作目录 `/home/kuanyi/git/sgt_qrcode/QRCodeService/bin/Debug/net5.0/` 
+
+## 更新程序
+- vs发布QRCodeService到文件系统路径下 比如 `/Publish`
+- 通过堡垒机`WinScp`将`/Publish`目录下的所有文件到服务器上
+- `systemctl stop qrcode` 关闭二维码服务 
+- 用上传的新文件包内容替换工作目录下的文件
+- `systemctl start qrcode` 重新启动二维码服务 
+