diff --git a/README.md b/README.md index 24c51dc72aa705da1a772d639b1d87143d9d3fd1..c59d87c4588fc3838fc2527d0a0693a6f0446d70 100644 --- a/README.md +++ b/README.md @@ -142,6 +142,60 @@ EOM.TSHotelManagement.Web **下载并安装Microsoft Visual Studio Professional 2022及以上版本,并通过下载Zip包解压,打开.sln后缀格式文件运行。** +### :inbox_tray: Docker运行部署(以Ubuntu为例): + +``` +docker run -d \ + --name tshotel-api \ + -v /app/config:/app/config \ + -v /app/keys:/app/keys \ + -e DefaultDatabase=MariaDB \ + -e ASPNETCORE_ENVIRONMENT=docker \ + -e DOCKER_ENV=true \ + -e "MariaDBConnectStr=Server=host;User=tshoteldb;Password=password;Database=tshoteldb" \ + -e Jwt__Issuer=Easy-Open-Meta \ + -e Jwt__Audience=EOM.TSHotelManagement.WebApi \ + -e Jwt__Key=Easy-Open-Meta-EfH@u4poHh544a53Sq77T \ + -e Jwt__ExpiryMinutes=20 \ + -e Lsky__BaseAddress=https://lsky.demo.top/api/v1 \ + -e Lsky__Email=demo@demo.top \ + -e Lsky__Password=demo \ + -e Lsky__UploadApi=/upload \ + -e Lsky__GetTokenApi=/tokens \ + -e Mail__Host=smtp.demo.top \ + -e Mail__UserName=demo@demo.top \ + -e Mail__Password=demo \ + -e Mail__Port=465 \ + -e Mail__EnableSsl=true \ + -e Mail__DisplayName=TSHotel-Administrator \ + -p 63001:8080 \ + yjj6731/tshotel-management-system-api:latest +``` + +| 参数名称 | 参数说明 | 必填(Y/N) | 默认值 | 可选值 | +|------|------|---------|-----|-----| +|name|容器名称|Y|N/A|N/A| +|DefaultDatabase|默认数据库|Y|N/A|MariaDB/MySql/SqlServer/PgSql| +|ASPNETCORE_ENVIRONMENT|系统环境(决定Dataprotection Key的生成位置)|Y|docker|docker| +|DOCKER_ENV|是否为docker环境|Y|true|true| +|{默认数据库(e.g:MariaDB/MySql/SqlServer/PgSql)}ConnectStr|对应数据库链接字符串|Y|N/A|N/A| +|Jwt__Issuer|签发者标识|Y|N/A|N/A| +|Jwt__Audience|目标接收方标识|Y|N/A|N/A| +|Jwt__Key|JWT Key|Y|N/A|N/A| +|Jwt__ExpiryMinutes|token有效时间/分钟|Y|20|N/A| +|Lsky__BaseAddress|兰空图床基础地址|Y|N/A|N/A| +|Lsky__Email|兰空图床账户邮箱|Y|N/A|N/A| +|Lsky__Password|兰空图床账户密码|Y|N/A|N/A| +|Lsky__UploadApi|兰空图床上传图片接口|Y|N/A|N/A| +|Lsky__GetTokenApi|兰空图床获取tokens接口|Y|N/A|N/A| +|Mail__Host|邮箱smtp协议地址|Y|N/A|N/A| +|Mail__UserName|邮箱smtp协议地址|Y|N/A|N/A| +|Mail__Port|邮箱smtp端口|Y|465|N/A| +|Mail__Password|邮箱密码|Y|N/A|N/A| +|Mail__EnableSsl|是否启用SSL|Y|true|true/false| +|Mail__DisplayName|发送邮件人显示名称|Y|N/A|N/A| + + ### :inbox_tray: 数据库运行部署(本地): **作者及开发团队强烈建议使用MariaDB数据库,安装MariaDB数据库并开启服务,通过可视化管理工具对数据库进行建立,可通过打开执行数据库脚本文件夹内的.sql后缀格式文件进行快速建立数据表和导入数据,执行步骤(以MariaDB数据库为例):**