Merge branch 'master' of github.com:nidbCN/AliCdnSSLWorker

.github/workflows/dotnet.yml

@@ -0,0 +1,28 @@
+# This workflow will build a .NET project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-net
+
+name: .NET
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 8.0.x
+    - name: Restore dependencies
+      run: dotnet restore
+    - name: Build
+      run: dotnet build --no-restore
+    - name: Test
+      run: dotnet test --no-build --verbosity normal

README.md

@@ -39,3 +39,64 @@
 如果你希望使用环境变量来传递配置，请直接按照配置文件中进行设置，在表示嵌套的对象时候使用 `__`，比如使用 `CERTCONFIG__CERTSERCHPATH` 来配置证书目录。
 
 > 注意：环境变量的优先级低于配置文件，如果在配置文件中设置了证书目录则会覆盖掉你在环境变量中的设置。
+
+## 使用
+
+### docker & docker compose 部署
+
+在项目源代码目录使用指令打包 docker 镜像：
+
+```bash
+docker build -t gaein/alicdn-ssl-worker:<your_version> .
+```
+
+如果出现类似提示，请在命令前加上 `sudo`
+
+```bash
+permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock: Get "http://%2Fvar%2Frun%2Fdocker.sock/v1.45/containers/json": dial unix /var/run/docker.sock: connect: permission denied
+```
+
+打包完成后使用 `docker images` 查看是否存在镜像
+
+新建目录，使用 `docker-compose` 来部署，示例的文件如下：
+
+```yaml
+volumes:
+  ssl_data:
+    driver: local
+    driver_opts:
+      type: none
+      o: bind
+      device: './nginx/letsencrypt'
+
+configs:
+  alicdn-ssl.conf:
+    file: './alicdn-ssl/appsettings.json'
+
+services:
+  alicdn-ssl:
+    image: 'gaein/alicdn-ssl-worker:v1.4'
+    container_name: 'alicdn-ssl'
+    environment:
+      TZ: 'Asia/Shanghai'
+    ports:
+      - 5057:5057
+    depends_on:
+      - nginx
+    restart: unless-stopped
+    volumes:
+      - ssl_data:/data/ssl
+    configs:
+      - source: alicdn-ssl.conf
+        target: '/app/appsettings.json'
+```
+
+### WebAPI
+
+为了方便控制，该项目启动了一个 HTTP 服务器并暴露了 WebAPI
+
+#### 强制上传所有证书
+
+```
+HTTP GET <IpAddress>:5057/force_refresh/
+```