MaaCopilotServer

MAA 作业服务器

API 定义

OpenAPI 3.0 文档

或者，在 Debug 模式下运行 MaaCopilotServer.Api，然后访问 http://localhost:${YOUR PORT}/swagger

编译与打包

前提条件：.NET SDK 6.0.x

编译：

dotnet build -c Release ./src/MaaCopilotServer.Api/MaaCopilotServer.Api.csproj

测试：

dotnet test --verbosity normal

发布：

dotnet publish -c Release -o ./publish ./src/MaaCopilotServer.Api/MaaCopilotServer.Api.csproj

制作 Docker 镜像：

docker build -t maa-copilot-server:latest .

使用 BuildX 制作 Docker 镜像：

docker buildx build --platform linux/amd64 -t maa-copilot-server:latest .
docker buildx build --platform linux/arm64 -t maa-copilot-server:latest .

开发时运行

若要在本机进行开发，可以使用以下命令，请复制一份 appsettings.json，命名为 appsettings.Development.json，并修改相关配置。

如果使用 Docker 配置本机运行环境，在配置中可以使用 host.docker.internal 代替 127.0.0.1 来连接到宿主机。

你需要运行有以下服务：

1. 数据库（必须）：Postgres 数据库，v14.x 版本
2. SMTP 服务器（必须）：推荐使用 rnwood/smtp4dev 在本地启动一个测试 SMTP 服务器
3. ELK Stack + APM（可选）：v8.x.x 版本，请参考 LiamSho/docker-compose#elk-apm

可以使用 localtest-docker.ps1 一键构建并运行 Docker 镜像。

数据库与 SMTP 服务器开发时使用参考 docker compose 文件：

version: '3'

services:
  pgsql:
    image: postgres:14
    container_name: postgres
    restart: unless-stopped
    environment:
      POSTGRES_DB: maa_copilot
      POSTGRES_PASSWORD: maa@passwd
      POSTGRES_USER: maa_admin
    volumes:
      - maa-copilot-data:/var/lib/postgresql/data
    ports:
     - 5432:5432

  smtp4dev:
    image: rnwood/smtp4dev:v3
    restart: unless-stopped
    ports:
      - '8089:80'
      - '25:25'
    volumes:
        - maa-smtp4dev-data:/smtp4dev
    environment:
      - ServerOptions__HostName=smtp.maa.plus
      - ServerOptions__LockSettings=true
      - ServerOptions__NumberOfMessagesToKeep=1000
      - ServerOptions__NumberOfSessionsToKeep=100

volumes:
  maa-copilot-data:
  maa-smtp4dev-data:

可以登录 localhost:8089 查看测试用 SMTP 服务器监控面板，SMTP 将在 25 端口监听，数据库将在 5432 端口监听

使用 Docker 运行

docker-compose

version: "3"

services:

  maa-copilot:
    image: alisaqaq/maa-copilot-server:latest
    container_name: maa-copilot
    depends_on:
      - pgsql
    volumes:
      - ./data:/app/data
    ports:
      - "8080:80"
  
  pgsql:
    image: postgres:latest
    container_name: pgsql
    environment:
      POSTGRES_USER: maa_admin
      POSTGRES_PASSWORD: maa@passwd
      POSTGRES_DB: maa_copilot
    volumes:
      - pgsql-data:/var/lib/postgresql/data
    
volumes:
    pgsql-data: