Skip to content

环境变量索引

本文档列出 Forge Admin 前端与后端的环境变量与配置项。

前端环境变量

前端基于 Vite,环境变量定义在项目根目录的 .env* 文件中:

文件用途
.env.development开发环境配置(pnpm dev 时加载)
.env.production生产环境配置(pnpm build 时加载)
.env.example环境变量模板(可提交,本地复制后修改)

⚠️ 只有以 VITE_ 前缀开头的变量才会暴露给客户端代码。

管理端(forge-admin-ui)

变量名说明示例值
VITE_HTTP_PORT开发服务器端口3000
VITE_REQUEST_PREFIX请求地址前缀/dev-api(开发)/ /forge-api(生产)
VITE_HTTP_PROXY_TARGET主服务代理地址(admin-server)http://127.0.0.1:8580/
VITE_FLOW_PROXY_TARGET流程服务代理地址(flow-server)http://127.0.0.1:8081/
VITE_RESOURCE_HOST图片 host 地址/
VITE_TEMPLATE_PATH模板文件下载地址/templates
VITE_APP_ID客户端 AppIdpc
VITE_USER_CLIENT登录设备标识(oauth2 / 免登登录一致)pc
VITE_PUBLIC_PATH生产静态资源目录/forge
VITE_BASE_URL生产路由前缀/forge

报表子系统单点登录与大屏兜底配置:

变量名说明示例值
VITE_SSO_BRIDGE_ROUTE单点登录跳转路由/report/design
VITE_SSO_TARGET_CLIENT目标客户端编码forge_report
VITE_SSO_TARGET_BASE_URLS子系统前端入口地址映射(JSON){"forge_report":"http://localhost:3021/forge-report"}
VITE_SSO_DEFAULT_REDIRECTS默认重定向(JSON){"forge_report":"/project/items"}
VITE_REPORT_UI_BASE_URL大屏前端地址兜底http://localhost:3021/forge-report
VITE_REPORT_UI_DEFAULT_REDIRECT大屏默认重定向/project/items
VITE_REPORT_UI_HOST_FALLBACK大屏 host 兜底localhost:3021
VITE_REPORT_UI_PATH_PREFIX大屏路径前缀/forge-report

移动端(forge-h5-ui)

变量名说明示例值
VITE_HTTP_PORT开发服务器端口3001
VITE_REQUEST_PREFIX请求地址前缀/dev-api
VITE_HTTP_PROXY_TARGETApp 服务代理地址(app-server)http://127.0.0.1:8583/
VITE_FLOW_PROXY_TARGET流程服务代理地址http://127.0.0.1:8081/
VITE_USER_CLIENT登录设备标识h5
VITE_APP_ID客户端 AppIdforge_h5

企业微信工作台免登已改为后端连接配置控制(sys_social_config.sso_workbench_enabled + connection_code),前端无需再配置。

后端 Spring Profiles

后端通过 Maven Profile 注入 Spring Profile(application.ymlspring.profiles.active: @profiles.active@):

Profile配置文件用途
localapplication-local.yml本地开发
devapplication-dev.yml开发环境
prodapplication-prod.yml生产环境

本地配置模板:复制 application-dev.example.ymlapplication-dev.yml(已 gitignore),填入 MySQL、Redis、AI 供应商等配置。

关键配置项

配置项说明
server.port服务端口(admin-server 默认 8580)
spring.application.name应用名(如 forge-admin-server
spring.datasource.dynamic.datasource.master.url主数据源 JDBC 地址(动态数据源)
spring.datasource.dynamic.datasource.master.username / password主数据源账号 / 密码
spring.data.redis.host / port / passwordRedis 连接
spring.data.redis.redisson.configRedisson 分布式锁配置

环境变量覆盖

环境变量对应配置项说明
FORGE_FLYWAY_ENABLEDspring.flyway.enabled是否启用 Flyway 迁移
FORGE_FLYWAY_LOCATIONSspring.flyway.locationsFlyway 迁移脚本扫描位置

Docker 环境变量

Docker 部署时通过环境变量覆盖默认配置(默认值见 docker-forge-admin/docker-compose.yml):

环境变量默认值说明
MYSQL_HOSTmysqlMySQL 主机
MYSQL_PORT3306MySQL 端口
MYSQL_DBforge_admin数据库名
MYSQL_USERroot数据库用户名
MYSQL_PASSWORDforge123456数据库密码
REDIS_HOSTredisRedis 主机
REDIS_PORT6379Redis 端口
REDIS_PASSWORDforge123456Redis 密码
JAVA_OPTS-Xms256m -Xmx512mJVM 参数

加密与凭据相关(生产建议显式配置):

环境变量说明
FORGE_CRYPTO_BOOTSTRAP_ENABLED / FORGE_CRYPTO_BOOTSTRAP_FILE密钥引导开关与引导文件
FORGE_CRYPTO_SECRET_KEY加密密钥
FORGE_CRYPTO_PERSISTENCE_ENABLED / WRITE_VERSIONED / LEGACY_READ_ENABLED持久化加密写版本 / 兼容读开关
FORGE_CRYPTO_PERSISTENCE_ACTIVE_KEY_ID / ACTIVE_KEY当前活跃密钥 ID 与密钥
FORGE_CRYPTO_PERSISTENCE_LEGACY_KEY兼容旧密钥
FORGE_AUTH_LEGACY_CLIENT_SECRET_READ_ENABLED兼容旧客户端凭据读取
yaml
# docker-compose.yml 示例(节选)
services:
  forge-admin:
    image: forge-admin:latest
    environment:
      MYSQL_HOST: mysql
      MYSQL_PORT: 3306
      MYSQL_DB: forge_admin
      MYSQL_USER: root
      MYSQL_PASSWORD: ${MYSQL_PASSWORD}
      REDIS_HOST: redis
      REDIS_PASSWORD: ${REDIS_PASSWORD}
    ports:
      - "8580:8580"

相关文档

Forge Admin — 基于 Vue3 + Spring Boot 的企业级后台管理框架