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）：

bash
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 配置完整部署环境（包含数据库示例）：

yaml
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 配置传入。完整参数说明如下：

变量名	类型	默认值	描述
SECRET_KEY	string	None	Django 安装的密钥，用于加密签名，需设置为唯一不可预测的值。
DEBUG	boolean	False	调试模式开关，生产环境需设为 `False`。
BASE_URL	string	[***]	Weni 引擎后端的基础 URL。
ALLOWED_HOSTS	string	*	Django 允许服务的主机/域名列表，多个值用逗号分隔。
DEFAULT_DATABASE	string	sqlite:///db.sqlite3	数据库连接配置，格式参考 django-environ。
LANGUAGE_CODE	string	en-us	语言代码，遵循 Django 语言 ID 格式。
TIME_ZONE	string	UTC	时区设置，参考时区列表。
STATIC_URL	string	/static/	静态文件访问 URL，对应 `STATIC_ROOT` 目录。
CSRF_COOKIE_DOMAIN	string	None	CSRF Cookie 的域名。
CSRF_COOKIE_SECURE	boolean	False	是否对 CSRF Cookie 使用安全连接（HTTPS）。
OIDC_RP_SERVER_URL	string	None	OpenID Connect 服务端 URL，例如：[***]
OIDC_RP_REALM_NAME	string	None	OpenID Connect 领域名称。
OIDC_RP_CLIENT_ID	string	None	OpenID Connect 客户端 ID（由 OP 提供）。
OIDC_RP_CLIENT_SECRET	string	None	OpenID Connect 客户端密钥（由 OP 提供）。
OIDC_OP_AUTHORIZATION_ENDPOINT	string	None	OpenID Connect 提供商的授权端点 URL。
OIDC_OP_TOKEN_ENDPOINT	string	None	OpenID Connect 提供商的令牌端点 URL。
OIDC_OP_USER_ENDPOINT	string	None	OpenID Connect 提供商的用户信息端点 URL。
OIDC_OP_JWKS_ENDPOINT	string	None	OpenID Connect 提供商的 JWKS 端点 URL。
OIDC_RP_SIGN_ALGO	string	RS256	IdP 用于签名 ID 令牌的算法。
OIDC_DRF_AUTH_BACKEND	string	weni.oidc_authentication.WeniOIDCAuthenticationBackend	Django REST Framework 的 OIDC 认证后端类。
AWS_ACCESS_KEY_ID	string	None	AWS S3 访问密钥 ID。
AWS_SECRET_ACCESS_KEY	string	None	AWS S3 密钥。
AWS_STORAGE_BUCKET_NAME	string	None	AWS S3 存储桶名称。
AWS_S3_REGION_NAME	string	None	AWS S3 存储桶所在区域。
EMAIL_HOST	string	None	邮件发送服务器主机。设为 `None` 或空字符串时，使用控制台邮件后端。
EMAIL_PORT	int	25	邮件发送服务器端口。
DEFAULT_FROM_EMAIL	string	webmaster@localhost	系统自动邮件的发件人地址。
SERVER_EMAIL	string	root@localhost	错误报告邮件（发送给 `ADMINS` 和 `MANAGERS`）的发件人地址。
EMAIL_HOST_USER	string	''	邮件服务器认证用户名。
EMAIL_HOST_PASSWORD	string	''	邮件服务器认证密码。
EMAIL_USE_SSL	boolean	False	是否对邮件连接使用 SSL 加密。
EMAIL_USE_TLS	boolean	False	是否对邮件连接使用 TLS 加密。
SEND_EMAILS	boolean	True	是否启用邮件发送功能。
INTELIGENCE_URL	string	[***]	智能服务的 URL。
FLOWS_URL	string	[***]	工作流服务的 URL。
USE_SENTRY	bool	False	是否启用 Sentry 监控支持。
SENTRY_URL	string	None	Sentry 服务 URL（DSN）。
APM_DISABLE_SEND	bool	False	是否禁用 Elastic APM 数据发送。
APM_SERVICE_DEBUG	bool	False	是否启用 APM 调试模式。
APM_SERVICE_NAME	string	''	APM 服务名称。
APM_SECRET_TOKEN	string	''	APM 密钥令牌。
APM_SERVER_URL	string	''	APM 服务器 URL。
FLOW_GRPC_ENDPOINT	string	'localhost:8002'	工作流服务的 gRPC 端点 URL。
INTELIGENCE_GRPC_ENDPOINT	string	'localhost:8003'	智能服务的 gRPC 端点 URL。
ENVIRONMENT	string	production	部署环境标识（如 production、staging、development），用于监控服务配置。