Weni 镜像文档

镜像概述和主要用途

Weni 镜像是 Weni 引擎的后端服务组件，基于 Django 框架构建，提供灵活可配置的后端支持能力。主要用于作为 Weni 生态系统的核心后端服务，处理 API 请求、集成第三方服务、管理数据存储及实现认证授权等核心功能。

核心功能和特性

• Django 后端框架：基于 Django 构建，支持标准 Django 配置及扩展，兼容 django-environ 环境配置。
• 多数据库支持：可通过环境变量配置多种数据库连接（如 SQLite、PostgreSQL、MySQL 等）。
• 认证与授权：集成 OpenID Connect (OIDC) 认证机制，支持第三方身份提供商（OP）对接。
• 存储集成：支持 AWS S3 存储服务，用于静态文件或其他资源的存储管理。
• 邮件服务：可配置 SMTP 邮件发送功能，支持邮件通知及系统告警。
• 第三方服务集成：支持与智能服务（INTELIGENCE_URL）、工作流服务（FLOWS_URL）对接，提供 gRPC 通信接口（FLOW_GRPC_ENDPOINT、INTELIGENCE_GRPC_ENDPOINT）。
• 监控与可观测性：支持 Sentry 错误监控和 Elastic APM 性能监控，可通过环境变量启用和配置。
• 环境适配：通过 ENVIRONMENT 变量区分部署环境（如生产、开发），并影响监控服务的配置。

使用场景和适用范围

• 企业级后端服务：作为核心 API 服务，支撑业务系统的数据处理和逻辑运算。
• 工作流管理系统：集成 flows 服务，实现复杂业务流程的编排与执行。
• 认证集成平台：通过 OIDC 对接统一身份认证系统，实现用户单点登录（SSO）。
• 第三方服务聚合：整合智能服务（如 NLP、数据分析）与业务系统，提供增强功能。
• 可扩展存储需求：需对接 AWS S3 等对象存储服务的应用场景。

使用方法和配置说明

Docker 快速启动

通过 docker run 命令快速启动 Weni 服务，需指定必要环境变量（如 SECRET_KEY）：

docker run -d \
  --name weni-engine \
  -p 8000:8000 \
  -e SECRET_KEY="your-unique-secret-key" \
  -e DEBUG="False" \
  -e BASE_URL="[***]" \
  -e ALLOWED_HOSTS="api.your-domain.com" \
  -e DEFAULT_DATABASE="postgres://user:password@db:5432/weni" \
  weni/weni-engine:latest

Docker Compose 部署

使用 docker-compose.yml 配置完整部署环境（包含数据库示例）：

version: '3.8'

services:
  weni-engine:
    image: weni/weni-engine:latest
    ports:
      - "8000:8000"
    environment:
      - SECRET_KEY=your-unique-secret-key
      - DEBUG=False
      - BASE_URL=[***]
      - ALLOWED_HOSTS=api.your-domain.com
      - DEFAULT_DATABASE=postgres://weni:password@db:5432/weni
      - LANGUAGE_CODE=zh-hans
      - TIME_ZONE=Asia/Shanghai
      - OIDC_RP_SERVER_URL=[***]
      - OIDC_RP_CLIENT_ID=your-oidc-client-id
      - OIDC_RP_CLIENT_SECRET=your-oidc-client-secret
      - AWS_STORAGE_BUCKET_NAME=your-s3-bucket
      - AWS_ACCESS_KEY_ID=your-aws-access-key
      - AWS_SECRET_ACCESS_KEY=your-aws-secret-key
      - USE_SENTRY=True
      - SENTRY_URL=[***]
      - ENVIRONMENT=production
    depends_on:
      - db

  db:
    image: postgres:13
    volumes:
      - postgres_data:/var/lib/postgresql/data/
    environment:
      - POSTGRES_USER=weni
      - POSTGRES_PASSWORD=password
      - POSTGRES_DB=weni

volumes:
  postgres_data:

环境变量配置

Weni 服务通过环境变量进行配置，支持操作系统环境变量、.env 文件或 Docker 配置传入。完整参数说明如下：

许可证

Weni 镜像基于 MPL-2.0 许可证分发。详见 LICENSE。

贡献指南

贡献是开源社区的核心价值，任何形式的贡献都将受到高度重视：

1. Fork 本项目
2. 创建特性分支（git checkout -b feature/AmazingFeature）
3. 提交变更（git commit -m 'Add some AmazingFeature'）
4. 推送到分支（git push origin feature/AmazingFeature）
5. 打开 Pull Request