ContextQMD
Back to Astron Agent

环境变量配置说明

docs/CONFIGURATION_zh.md

1.0.622.8 KB
Original Source

环境变量配置说明

本文档详细说明了系统所需的所有环境变量配置项，包括中间件、服务端口、认证、业务模块等配置。

快速开始

必须手动配置的关键字段

在使用 Docker Compose 部署之前，以下环境变量必须手动配置。详细的配置步骤和说明请参考 部署指南。

关键配置项概览：

  • 讯飞开放平台凭证（需要申请）:

    • PLATFORM_APP_ID、PLATFORM_API_KEY、PLATFORM_API_SECRET
    • SPARK_API_PASSWORD、SPARK_RTASR_API_KEY

  • Casdoor 认证配置（需要部署 Casdoor 服务）:

    • CONSOLE_CASDOOR_URL、CONSOLE_CASDOOR_ID
    • CONSOLE_CASDOOR_APP、CONSOLE_CASDOOR_ORG

  • RAGFlow 知识库配置（如使用 RAGFlow 作为知识库）:

    • RAGFLOW_BASE_URL、RAGFLOW_API_TOKEN、RAGFLOW_DEFAULT_GROUP

  • 主机地址配置:

    • HOST_BASE_ADDRESS - 设置为您的服务器地址或域名

配置项说明

文档中的配置项按以下方式标注：

  • 用户必填: 必须手动配置的字段（无默认值或需要申请外部服务）
  • 使用默认: 推荐使用 Docker Compose 提供的默认配置（如果使用外部中间件则需修改）
  • 必填: 必须存在但已提供默认值的配置（通常无需修改）
  • 可选: 非必需配置，可按需启用
  • 条件必填: 在特定场景下才需要配置的字段

1. 中间件配置模块

独立部署说明:

  • 如果使用 Docker Compose 一键部署，以下配置中使用容器名（如 postgres、mysql、redis、kafka、minio）作为主机地址即可
  • 如果中间件服务单独部署（不在同一 Docker 网络中），需要将以下配置中的容器名修改为实际的 IP 地址或域名，并同步修改对应的连接信息（如用户名、密码、端口等）：
    • PostgreSQL 相关：POSTGRES_HOST、POSTGRES_USER、POSTGRES_PASSWORD、POSTGRES_PORT 等
    • MySQL 相关：MYSQL_HOST、MYSQL_USER、MYSQL_PASSWORD、MYSQL_URL 等
    • Redis 相关：REDIS_ADDR、REDIS_HOST、REDIS_PASSWORD、REDIS_PORT 等
    • Kafka 相关：KAFKA_SERVERS 及认证信息（如需要）
    • MinIO 相关：OSS_ENDPOINT、OSS_DOWNLOAD_HOST、OSS_ACCESS_KEY_ID、OSS_SECRET_KEY 等
变量名配置类型类型用途说明示例值
POSTGRES_USER使用默认stringPostgreSQL 数据库用户名spark
POSTGRES_PASSWORD使用默认stringPostgreSQL 数据库密码spark123
POSTGRES_HOST使用默认stringPostgreSQL 数据库主机地址postgres
POSTGRES_PORT使用默认intPostgreSQL 数据库端口号5432
MYSQL_ROOT_PASSWORD使用默认stringMySQL 数据库 root 用户密码root123
MYSQL_USER使用默认stringMySQL 数据库用户名root
MYSQL_PASSWORD使用默认stringMySQL 数据库密码(默认从 MYSQL_ROOT_PASSWORD 获取)root123
MYSQL_HOST使用默认stringMySQL 数据库主机地址mysql
MYSQL_PORT使用默认intMySQL 数据库端口号3306
MYSQL_URL使用默认stringMySQL 数据库 JDBC 连接 URLjdbc:mysql://mysql:3306/astron_console
REDIS_PASSWORD可选stringRedis 密码(为空表示无密码)(留空)
REDIS_DATABASE使用默认intRedis 数据库索引(0-15)0
REDIS_IS_CLUSTER使用默认boolRedis 是否为集群模式false
REDIS_CLUSTER_ADDR可选stringRedis 集群地址(集群模式时使用)redis1:6379,redis2:6379
REDIS_EXPIRE使用默认intRedis 缓存过期时间(秒)3600
REDIS_ADDR使用默认stringRedis 连接地址(单机模式)redis:6379
REDIS_HOST使用默认stringRedis 主机地址redis
REDIS_PORT使用默认intRedis 端口号6379
ELASTICSEARCH_SECURITY_ENABLED使用默认boolElasticsearch 是否启用安全认证false
ES_JAVA_OPTS使用默认stringElasticsearch JVM 参数配置-Xms512m -Xmx512m
EXPOSE_KAFKA_PORT使用默认intKafka 对外暴露的端口号9092
KAFKA_REPLICATION_FACTOR使用默认intKafka 副本因子1
KAFKA_CLUSTER_ID使用默认stringKafka 集群 IDMkU3OEVBNTcwNTJENDM2Qk
KAFKA_TIMEOUT使用默认intKafka 连接超时时间(秒)60
KAFKA_SERVERS使用默认stringKafka 服务器地址列表kafka:29092
MINIO_ROOT_USER使用默认stringMinIO 管理员用户名minioadmin
MINIO_ROOT_PASSWORD使用默认stringMinIO 管理员密码minioadmin123
EXPOSE_MINIO_PORT使用默认intMinIO API 对外暴露的端口号18998
EXPOSE_MINIO_CONSOLE_PORT使用默认intMinIO 控制台对外暴露的端口号18999
OSS_TYPE使用默认string对象存储类型(s3/oss/obs 等)s3
OSS_ENDPOINT使用默认url对象存储服务端点地址http://minio:9000
OSS_ACCESS_KEY_ID使用默认string对象存储访问密钥 ID${MINIO_ROOT_USER:-minioadmin}
OSS_ACCESS_KEY_SECRET使用默认string对象存储访问密钥 Secret${MINIO_ROOT_PASSWORD:-minioadmin123}
OSS_BUCKET_NAME使用默认string对象存储桶名称workflow
OSS_TTL使用默认int对象存储 URL 有效期(秒)157788000
OSS_DOWNLOAD_HOST使用默认url对象存储下载访问地址http://minio:9000

2. 监控配置模块 (OTLP)

变量名配置类型类型用途说明示例值
OTLP_ENABLE必填int是否启用 OTLP 监控(0=禁用, 1=启用)0
OTLP_ENDPOINT必填stringOTLP 服务端点地址127.0.0.1:4317
OTLP_METRIC_TIMEOUT必填intOTLP 指标上报超时时间(毫秒)3000
OTLP_METRIC_EXPORT_INTERVAL_MILLIS必填intOTLP 指标导出间隔(毫秒)3000
OTLP_METRIC_EXPORT_TIMEOUT_MILLIS必填intOTLP 指标导出超时(毫秒)3000
OTLP_TRACE_TIMEOUT必填intOTLP 追踪超时时间(毫秒)3000
OTLP_TRACE_MAX_QUEUE_SIZE必填intOTLP 追踪队列最大大小2048
OTLP_TRACE_SCHEDULE_DELAY_MILLIS必填intOTLP 追踪调度延迟(毫秒)3000
OTLP_TRACE_MAX_EXPORT_BATCH_SIZE必填intOTLP 追踪批量导出最大数量2048
OTLP_TRACE_EXPORT_TIMEOUT_MILLIS必填intOTLP 追踪导出超时(毫秒)3000

3. 基础服务端口配置

变量名配置类型类型用途说明示例值
EXPOSE_NGINX_PORT必填intNginx 对外暴露的端口号80
CORE_TENANT_PORT必填intTenant 核心服务端口号5052
CORE_DATABASE_PORT必填intDatabase 核心服务端口号7990
CORE_RPA_PORT必填intRPA 核心服务端口号17198
CORE_LINK_PORT必填intLink 核心服务端口号18888
CORE_AITOOLS_PORT必填intAITools 核心服务端口号18668
CORE_AGENT_PORT必填intAgent 核心服务端口号17870
CORE_KNOWLEDGE_PORT必填intKnowledge 核心服务端口号20010
CORE_WORKFLOW_PORT必填intWorkflow 核心服务端口号7880

4. 认证配置模块 (Casdoor)

变量名配置类型类型用途说明示例值
CONSOLE_CASDOOR_URL用户必填urlCasdoor 认证服务器地址http://your-casdoor-server:8000
CONSOLE_CASDOOR_ID用户必填stringCasdoor OAuth2 客户端 IDastron-agent-client
CONSOLE_CASDOOR_APP用户必填stringCasdoor 应用名称astron-agent-app
CONSOLE_CASDOOR_ORG用户必填stringCasdoor 组织名称built-in

5. Tenant 模块配置

变量名配置类型类型用途说明示例值
DATABASE_DB_TYPE必填string数据库类型mysql
DATABASE_USERNAME必填string数据库用户名(默认从 MYSQL_USER 获取)${MYSQL_USER:-root}
DATABASE_PASSWORD必填string数据库密码(默认从 MYSQL_PASSWORD 获取)${MYSQL_PASSWORD:-root123}
DATABASE_URL必填string数据库连接 URL(mysql:3306)/tenant
DATABASE_MAX_OPEN_CONNS必填int数据库最大连接数5
DATABASE_MAX_IDLE_CONNS必填int数据库最大空闲连接数5
LOG_PATH必填string日志文件路径log.txt

6. Database 模块配置

变量名配置类型类型用途说明示例值
DATABASE_POSTGRES_DATABASE必填stringPostgreSQL 数据库名称sparkdb_manager

7. RPA 模块配置

变量名配置类型类型用途说明示例值
RPA_URL必填urlRPA 服务基础地址https://newapi.iflyrpa.com
XIAOWU_RPA_TASK_CREATE_URL必填url小悟 RPA 任务创建接口地址(默认从 RPA_URL 拼接)${RPA_URL}/api/rpa-openapi/workflows/execute-async
XIAOWU_RPA_TASK_QUERY_URL必填url小悟 RPA 任务查询接口地址(默认从 RPA_URL 拼接)${RPA_URL}/api/rpa-openapi/executions

8. Link 模块配置

变量名配置类型类型用途说明示例值
LINK_MYSQL_DB必填stringLink 模块使用的 MySQL 数据库名称spark-link

9. Agent 模块配置

变量名配置类型类型用途说明示例值
SERVICE_HOST必填string服务监听主机地址0.0.0.0
SERVICE_WORKERS必填int服务工作进程数1
SERVICE_RELOAD必填bool是否启用服务热重载false
SERVICE_WS_PING_INTERVAL必填bool/intWebSocket 心跳间隔false
SERVICE_WS_PING_TIMEOUT必填bool/intWebSocket 心跳超时false
AGENT_MYSQL_DB必填stringAgent 模块使用的 MySQL 数据库名称agent
UPLOAD_NODE_TRACE必填bool是否上传节点追踪数据true
UPLOAD_METRICS必填bool是否上传指标数据true
AGENT_KAFKA_TOPIC必填stringAgent 使用的 Kafka 主题名称spark-agent-builder
GET_LINK_URL必填url获取工具链接的接口地址http://core-link:18888/api/v1/tools
VERSIONS_LINK_URL必填url获取工具版本的接口地址http://core-link:18888/api/v1/tools/versions
RUN_LINK_URL必填url运行工具的接口地址http://core-link:18888/api/v1/tools/http_run
GET_WORKFLOWS_URL必填url获取工作流的接口地址(默认从 CORE_WORKFLOW_PORT 获取端口)http://core-workflow:${CORE_WORKFLOW_PORT:-7880}/sparkflow/v1/protocol/get
WORKFLOW_SSE_BASE_URL必填url工作流 SSE(服务器推送事件)基础地址(默认从 CORE_WORKFLOW_PORT 获取端口)http://core-workflow:${CORE_WORKFLOW_PORT:-7880}/workflow/v1
CHUNK_QUERY_URL必填url知识库分块查询接口地址(默认从 CORE_KNOWLEDGE_PORT 获取端口)http://core-knowledge:${CORE_KNOWLEDGE_PORT:-20010}/knowledge/v1/chunk/query
LIST_MCP_PLUGIN_URL必填url列出 MCP 插件的接口地址http://core-link:18888/api/v1/mcp/tool_list
RUN_MCP_PLUGIN_URL必填url运行 MCP 插件的接口地址http://core-link:18888/api/v1/mcp/call_tool
APP_AUTH_HOST必填string应用认证服务主机地址(默认从 CORE_TENANT_PORT 获取端口)core-tenant:${CORE_TENANT_PORT:-5052}
APP_AUTH_PROT必填string应用认证服务协议(http/https)http
APP_AUTH_API_KEY必填string应用认证 API Key7b709739e8da44536127a333c7603a83
APP_AUTH_SECRET必填string应用认证 SecretNjhmY2NmM2NkZDE4MDFlNmM5ZjcyZjMy

10. Knowledge 模块配置

知识库选择说明: 系统支持两种知识库方式，根据实际需求选择其中一种进行配置：

  • RAGFlow: 使用 RAGFlow 知识库服务（需要配置 RAGFLOW_* 相关变量）
  • 星火知识库: 使用讯飞星火知识库服务（需要配置 XINGHUO_DATASET_ID）

选择哪一种方式，对应的配置项就是必填的；未选择的方式可以留空。

变量名配置类型类型用途说明示例值
RAGFLOW_BASE_URL条件必填urlRAGFlow 服务基础地址（使用 RAGFlow 时必填）http://localhost:10080
RAGFLOW_API_TOKEN条件必填stringRAGFlow API 访问令牌（使用 RAGFlow 时必填）your-ragflow-token
RAGFLOW_TIMEOUT条件必填intRAGFlow 请求超时时间(秒)（使用 RAGFlow 时必填）60
RAGFLOW_DEFAULT_GROUP条件必填stringRAGFlow 默认分组名称（使用 RAGFlow 时必填）Astron Knowledge Base
XINGHUO_DATASET_ID条件必填string星火知识库数据集 ID（使用星火知识库时必填）(留空)

11. Workflow 模块配置

变量名配置类型类型用途说明示例值
WORKFLOW_MYSQL_DB必填stringWorkflow 模块使用的 MySQL 数据库名称workflow
WORKFLOW_KAFKA_TOPIC必填stringWorkflow 使用的 Kafka 主题名称spark-agent-builder
RUNTIME_ENV必填string运行环境(dev/test/prod)dev

12. Console 模块配置

变量名配置类型类型用途说明示例值
HOST_BASE_ADDRESS用户必填url主机基础地址http://localhost
CONSOLE_DOMAIN必填urlConsole 控制台域名地址(默认从 HOST_BASE_ADDRESS 和 EXPOSE_NGINX_PORT 组合)${HOST_BASE_ADDRESS}:${EXPOSE_NGINX_PORT}
OSS_REMOTE_ENDPOINT必填url对象存储远程端点地址(默认从 HOST_BASE_ADDRESS 和 EXPOSE_MINIO_PORT 组合)${HOST_BASE_ADDRESS}:${EXPOSE_MINIO_PORT}
OSS_BUCKET_CONSOLE必填stringConsole 使用的对象存储桶名称console-oss
OSS_PRESIGN_EXPIRY_SECONDS_CONSOLE必填intConsole 预签名 URL 过期时间(秒)600
REDIS_DATABASE_CONSOLE必填intConsole 使用的 Redis 数据库索引1
OAUTH2_ISSUER_URI必填urlOAuth2 颁发者 URI(默认从 CONSOLE_CASDOOR_URL 获取)${CONSOLE_CASDOOR_URL:-http://auth-server:8000}
OAUTH2_JWK_SET_URI必填urlOAuth2 JWK 密钥集 URI(默认从 CONSOLE_CASDOOR_URL 获取)${CONSOLE_CASDOOR_URL:-http://auth-server:8000}/.well-known/jwks
OAUTH2_AUDIENCE必填stringOAuth2 受众标识(默认从 CONSOLE_CASDOOR_ID 获取)${CONSOLE_CASDOOR_ID:-your-oauth2-client-id}
PLATFORM_APP_ID用户必填string讯飞开放平台应用 IDyour-app-id
PLATFORM_API_KEY用户必填string讯飞开放平台 API Keyyour-api-key
PLATFORM_API_SECRET用户必填string讯飞开放平台 API Secretyour-api-secret
AI_ABILITY_CHAT_BASE_URL可选url文本模型服务地址(OpenAI 兼容接口)(默认从 PLATFORM_API_KEY 获取)${PLATFORM_API_KEY}
AI_ABILITY_CHAT_MODEL可选string文本模型名称${AI_ABILITY_CHAT_MODEL}
AI_ABILITY_CHAT_API_KEY可选string文本模型 API Key${AI_ABILITY_CHAT_API_KEY}
SPARK_RTASR_API_KEY用户必填string星火实时语音转写 API Keyyour-rtasr-api-key
SPARK_API_PASSWORD用户必填string星火大模型 API 密码your-api-password
SPARK_APP_ID必填string星火服务应用 ID(默认从 PLATFORM_APP_ID 获取)${PLATFORM_APP_ID}
SPARK_API_KEY必填string星火服务 API Key(默认从 PLATFORM_API_KEY 获取)${PLATFORM_API_KEY}
SPARK_API_SECRET必填string星火服务 API Secret(默认从 PLATFORM_API_SECRET 获取)${PLATFORM_API_SECRET}
SPARK_RTASR_APPID必填string星火实时语音转写应用 ID(默认从 PLATFORM_APP_ID 获取)${PLATFORM_APP_ID}
SPARK_RTASR_KEY必填string星火实时语音转写 Key(默认从 SPARK_RTASR_API_KEY 获取)${SPARK_RTASR_API_KEY}
SPARK_IMAGE_APP_ID必填string星火图像生成应用 ID(默认从 PLATFORM_APP_ID 获取)${PLATFORM_APP_ID}
SPARK_IMAGE_API_KEY必填string星火图像生成 API Key(默认从 PLATFORM_API_KEY 获取)${PLATFORM_API_KEY}
SPARK_IMAGE_API_SECRET必填string星火图像生成 API Secret(默认从 PLATFORM_API_SECRET 获取)${PLATFORM_API_SECRET}
WECHAT_COMPONENT_APPID可选string微信第三方平台 AppIDyour-wechat-component-appid
WECHAT_COMPONENT_SECRET可选string微信第三方平台 Secretyour-wechat-secret
WECHAT_TOKEN可选string微信消息校验 Tokenyour-wechat-token
WECHAT_ENCODING_AES_KEY可选string微信消息加密密钥your-wechat-encoding-aes-key
WORKFLOW_CHAT_URL必填url工作流对话接口地址(默认从 CORE_WORKFLOW_PORT 获取端口)http://core-workflow:${CORE_WORKFLOW_PORT:-7880}/workflow/v1/chat/completions
WORKFLOW_DEBUG_URL必填url工作流调试接口地址(默认从 CORE_WORKFLOW_PORT 获取端口)http://core-workflow:${CORE_WORKFLOW_PORT:-7880}/workflow/v1/debug/chat/completions
WORKFLOW_RESUME_URL必填url工作流恢复接口地址(默认从 CORE_WORKFLOW_PORT 获取端口)http://core-workflow:${CORE_WORKFLOW_PORT:-7880}/workflow/v1/resume
TENANT_ID必填string租户 ID680ab54f
TENANT_KEY必填string租户 API Key7b709739e8da44536127a333c7603a83
TENANT_SECRET必填string租户 SecretNjhmY2NmM2NkZDE4MDFlNmM5ZjcyZjMy
COMMON_APPID必填string通用应用 ID(默认从 TENANT_ID 获取)${TENANT_ID}
COMMON_APIKEY必填string通用 API Key(默认从 TENANT_KEY 获取)${TENANT_KEY}
COMMON_API_SECRET必填string通用 API Secret(默认从 TENANT_SECRET 获取)${TENANT_SECRET}
ADMIN_UID必填string管理员用户 ID9999
APP_URL必填url应用服务接口地址(默认从 CORE_TENANT_PORT 获取端口)http://core-tenant:${CORE_TENANT_PORT:-5052}/v2/app
KNOWLEDGE_URL必填url知识库服务接口地址(默认从 CORE_KNOWLEDGE_PORT 获取端口)http://core-knowledge:${CORE_KNOWLEDGE_PORT:-20010}/knowledge
TOOL_URL必填url工具服务接口地址http://core-link:18888
WORKFLOW_URL必填url工作流服务接口地址(默认从 CORE_WORKFLOW_PORT 获取端口)http://core-workflow:${CORE_WORKFLOW_PORT:-7880}
SPARK_DB_URL必填urlSpark 数据库服务接口地址(默认从 CORE_DATABASE_PORT 获取端口)http://core-database:${CORE_DATABASE_PORT:-7990}
LOCAL_MODEL_URL必填url本地模型服务地址http://127.0.0.1:33778

13. MaaS 平台配置模块

变量名配置类型类型用途说明示例值
MAAS_APP_ID必填stringMaaS 平台应用 ID(默认从 PLATFORM_APP_ID 获取)${PLATFORM_APP_ID}
MAAS_API_KEY必填stringMaaS 平台 API Key(默认从 PLATFORM_API_KEY 获取)${PLATFORM_API_KEY}
MAAS_API_SECRET必填stringMaaS 平台 API Secret(默认从 PLATFORM_API_SECRET 获取)${PLATFORM_API_SECRET}
MAAS_CONSUMER_ID必填stringMaaS 消费者 ID(默认从 TENANT_ID 获取)${TENANT_ID}
MAAS_CONSUMER_KEY必填stringMaaS 消费者 Key(默认从 TENANT_KEY 获取)${TENANT_KEY}
MAAS_CONSUMER_SECRET必填stringMaaS 消费者 Secret(默认从 TENANT_SECRET 获取)${TENANT_SECRET}
MAAS_WORKFLOW_VERSION必填urlMaaS 工作流版本接口地址http://127.0.0.1:8080/workflow/version
MAAS_SYNCHRONIZE_WORK_FLOW必填urlMaaS 同步工作流接口地址http://127.0.0.1:8080/workflow
MAAS_PUBLISH必填urlMaaS 发布接口地址http://127.0.0.1:8080/workflow/publish
MAAS_CLONE_WORK_FLOW必填urlMaaS 克隆工作流接口地址http://127.0.0.1:8080/workflow/internal-clone
MAAS_GET_INPUTS必填urlMaaS 获取输入信息接口地址http://127.0.0.1:8080/workflow/get-inputs-info
MAAS_CAN_PUBLISH_URL必填urlMaaS 检查是否可发布接口地址http://127.0.0.1:8080/workflow/can-publish
MAAS_PUBLISH_API必填urlMaaS 发布 API 接口地址(默认从 CORE_WORKFLOW_PORT 获取端口)http://core-workflow:${CORE_WORKFLOW_PORT:-7880}/workflow/v1/publish
MAAS_AUTH_API必填urlMaaS 认证 API 接口地址(默认从 CORE_WORKFLOW_PORT 获取端口)http://core-workflow:${CORE_WORKFLOW_PORT:-7880}/workflow/v1/auth
MAAS_MCP_REGISTER必填urlMaaS MCP 注册接口地址http://127.0.0.1:8080/workflow/release
MAAS_WORKFLOW_CONFIG必填urlMaaS 工作流配置接口地址http://127.0.0.1:8080/workflow/get-flow-advanced-config
BOT_API_CBM_BASE_URL必填urlBot API CBM 基础地址(支持 ws/wss,注意 env.example 中写作 ws(s)://)wss://spark-openapi.cn-huabei-1.xf-yun.com
BOT_API_MAAS_BASE_URL必填urlBot API MaaS 基础地址(注意 env.example 中写作 http(s)://)https://xingchen-api.xf-yun.com
TENANT_CREATE_APP必填url租户创建应用接口地址(默认从 CORE_TENANT_PORT 获取端口)http://core-tenant:${CORE_TENANT_PORT:-5052}/v2/app
TENANT_GET_APP_DETAIL必填url租户获取应用详情接口地址(默认从 CORE_TENANT_PORT 获取端口)http://core-tenant:${CORE_TENANT_PORT:-5052}/v2/app/details

14. 第三方服务配置

变量名配置类型类型用途说明示例值
DEEPSEEK_URL必填urlDeepSeek API 接口地址https://api.deepseek.com/chat/completions
DEEPSEEK_API_KEY可选stringDeepSeek API Keysk-xxx

15. 其他系统配置

变量名配置类型类型用途说明示例值
SERVICE_LOCATION必填string服务可用区(dx/hf/gz)hf
HEALTH_CHECK_INTERVAL必填string健康检查间隔时间30s
HEALTH_CHECK_TIMEOUT必填string健康检查超时时间10s
HEALTH_CHECK_RETRIES必填int健康检查重试次数60
NETWORK_SUBNET必填stringDocker 网络子网配置172.20.0.0/16

相关文档

贡献

如发现配置项说明有误或需要补充，欢迎提交 Issue 或 Pull Request。