BuildingAI 帮助文档
BuildingAI 官网
  1. 安装教程
  • 欢迎使用 BuildingAI
  • 演示环境
  • 用户社群
  • 产品线路图
  • 更新日志
  • 开源与商业化
  • API 赞助商
  • 积分获取方式
  • 安装教程
    • 宝塔面板部署
    • Windows 环境下 Docker 部署
    • Docker方式安装
    • 手动安装
  • 使用教程
    • 功能使用教程
    • 智能体
    • DIY中心
    • 计费管理
    • 支付配置
    • 公众号配置
    • OSS存储配置
    • 应用安装教程
  • 开发文档
    • 网络接口
      • 登录注册
        • 账号密码登录
        • 账号密码注册
      • 前台
        • 文件上传/下载
          • 单个上传
          • 多个上传
          • 列表
          • 详情
          • 下载
          • 删除
        • 用户
          • 算力明细
          • 登录配置
        • AI聊天
          • 对话(非流式)
          • 流式对话
          • 对话记录
          • 对话详情
          • 修改记录
          • 删除记录
          • 获取记录对话
        • MCP
          • 列表
          • 所有记录
          • 详情:id
          • 创建
          • 修改
          • 可见状态
          • 添加
          • 关联详情
          • 系统MCP
          • json导入
          • 移除
          • 删除
          • 获取快捷菜单
          • 系统MCP详情:id
          • 连通性
          • 批量连通性
        • 充值中心
          • 充值中心
          • 充值提交订单
          • 充值记录
          • 预支付
          • 获取支付结果
        • 模型厂商
          • 列表
          • 详情:id
          • 详情:code
        • AI模型
          • 列表
          • 详情:id
          • 默认模型
        • 数据分析
          • 数据记录
        • 会员中心
          • 会员中心信息
          • 获取套餐列表
          • 预支付
          • 订阅提交订单
      • 后台
        • 工作空间
          • MCP
            • 列表
            • 详情
            • 创建
            • 修改
            • 删除
            • 批量删除
            • 启用状态
            • json导入
            • 连通性
            • 批量连通性
            • 获取快捷菜单
            • 设置快捷菜单
          • AI模型
            • 厂商管理
              • 列表
              • 新增
              • 详情:id
              • 详情:provider
              • 修改
              • 删除
              • 状态
            • 模型管理
              • 列表
              • 新增
              • 详情:id
              • 修改
              • 删除:id
              • 批量删除
              • 设为默认
              • 模型类型
              • 模型支持能力
              • 父级模型类型
          • AI知识库
            • 知识库列表
            • 知识库详情
            • 转移知识库
            • 知识库删除
            • 知识库文档列表
            • 知识库文档详情
            • 知识库文档删除
            • 知识库分段列表
            • 知识库分段详情
            • 知识库分段删除
            • 数据列表接口
          • AI智能体
            • 智能体创建
            • 智能体列表
            • 智能体详情
            • 智能体对话记录列表
            • 智能体对话记录详情
            • 智能体对话
            • 智能体发布API接口对话
            • 智能体发布API获取对话列表
            • 智能体发布API获取对话消息
            • 智能体发布API更新对话
            • 智能体发布API删除对话
          • 密钥管理
            • 密钥模板
              • 列表
              • 全部列表
              • 详情
              • 创建
              • 修改
              • 删除
              • 批量删除
              • 修改状态
              • json导入
            • 密钥配置
              • 列表
              • 列表:templateId
              • 创建
              • 统计
              • 详情
              • 完整详情
              • 修改
              • 修改状态
              • 删除
              • 批量删除
        • 用户管理
          • 列表
          • 创建
          • 详情:id
          • 删除
          • 批量删除
          • 重置密码
          • 更新状态
          • 重置随机密码
          • 登录设置
          • 登录设置
        • 角色管理
          • 创建
          • 详情:id
          • 修改
          • 删除
          • 列表
        • 菜单管理
          • 创建
          • 详情:id
          • 修改
          • 删除
          • 列表
        • 插件管理
          • 我的插件
            • 列表
            • 修改
            • 详情:id
            • 创建
            • 启用列表
            • 批量删除
            • 删除:id
            • 批量状态
            • 禁用:id
            • 启用:id
            • 是否存在:identifier
            • 详情:identifier
            • 入库插件详情:identifier
            • 本地列表
            • 类型列表
            • 版本列表:identifier
            • 安装
            • 卸载
          • 插件操作
            • 下载
            • 安装
          • 平台密钥
            • 获取开发者密钥
            • 设置开发者密钥
        • 权限管理
          • 列表
          • 扫描权限
          • 同步到库
          • 扫描接口
          • 清理废弃权限
          • 详情:code
        • 字典配置
          • 列表
        • 系统操作
          • 支付配置
            • 列表
            • 详情:id
            • 状态
            • 更新
          • 系统信息
            • 安装状态
            • 安装状态
          • pm2
            • 进程列表
            • 日志
            • 重启
            • 重载
            • 停止进程
            • 进程详情
            • 进程状态
            • 清空日志
            • 保存进程
            • 健康检查
            • 删除进程
        • 套餐充值
          • 获取套餐充值配置
          • 获取套餐充值配置 Copy
        • 财务
          • 财务中心
          • 用户余额明细
        • 订单管理
          • 充值订单列表
          • 充值订单详情
          • 充值订单退款
          • 会员订单列表
        • 渠道管理
          • 公众号配置
            • 详情
            • 修改
        • 数据分析
          • 数据看板
        • VIP 会员
          • 会员等级
            • 新增会员等级
            • 会员等级列表
            • 修改会员等级
            • 会员等级详情
            • 删除会员等级
          • 订阅计划
            • 新增订阅计划
            • 订阅计划设置
            • 设置会员功能状态
            • 更改订阅计划状态
            • 订阅计划详情
            • 修改订阅计划
            • 删除订阅计划
            • 更新订阅计划排序
      • 插件
        • 文章插件
          • 前台
            • 列表
          • 后台
            • 文章
              • 列表
              • 创建
            • 分类
              • 列表
              • 创建
        • 智能体-企业微信插件
          • 对话接口
        • 配图大师
          • 后台
            • 配图记录
            • 获取配图插件
            • 插件设置
    • 插件与框架开发
      • 技术规范
      • 前置准备
      • 本地部署与开发
      • 目录结构
      • 项目配置
      • 应用开发
        • 介绍
        • 创建应用
        • 模板结构
        • 应用开发
        • 打包发布
        • 插件更新
      • PC 客户端
        • 开发文档
        • 构建文档
  • 设计资源
    • 官方素材库
  • 政策
    • 开源许可
    • 服务条款
    • 隐私政策
BuildingAI 官网
  1. 安装教程

手动安装

环境准备#

NodeJS ≥22 官网下载地址
PostgreSQL ≥15 官网下载地址
Redis ≥6.2 官网下载地址
安装好之后验证是否安装成功
node -v
npm -v
psql --version
redis-cli --version

拉取代码到本地#

# Gitee仓库
git clone https://gitee.com/BidingCC/BuildingAI.git

# or Github仓库
git clone https://github.com/BidingCC/BuildingAI.git

安装依赖#

如果网络慢,可以先配置淘宝镜像:
npm config set registry https://registry.npmmirror.com
# 如果没有pnpm,需要先安装pnpm
npm install -g pnpm
# 进入项目目录
cd BuildingAI
# 安装依赖
pnpm install

配置环境变量#

cp .env.example .env
根据你的实际环境配置,编辑 .env 文件,配置数据库连接、Redis连接等环境变量配置
# Base
# 项目名称
APP_NAME=BuildingAI
# if you deploy to production, please set this to real url
# 项目域名
APP_DOMAIN=
# Server
# 后端服务端口
SERVER_PORT=4090
# 是否启用 CORS
SERVER_CORS_ENABLED=true
# CORS 允许的来源
SERVER_CORS_ORIGIN=*
# 是否显示详细的错误信息
SERVER_SHOW_DETAILED_ERRORS=false
# 是否是演示环境
SERVER_IS_DEMO_ENV=false
# PM2
# PM2 应用名称
PM2_APP_NAME=buildingai
# PM2 实例数量
PM2_INSTANCES=1
# PM2 执行模式
PM2_EXEC_MODE=cluster
# PM2 最大内存
PM2_MAX_MEMORY=1G
# PM2 是否监控
PM2_WATCH=false
# PM2 日志目录
PM2_LOG_DIR=../../logs/pm2
# PM2 自动重启
PM2_AUTORESTART=true
# PM2 日志日期格式
PM2_LOG_DATE_FORMAT=YYYY-MM-DD HH:mm:ss Z
# JWT
# JWT 密钥
JWT_SECRET=buildingai
# JWT 过期时间
JWT_EXPIRES_IN=1d
# Database
# 数据库类型
DB_TYPE=postgres
# 数据库主机
DB_HOST=localhost
# 数据库端口
DB_PORT=5432
# 数据库用户名
DB_USERNAME=postgres
# 数据库密码
DB_PASSWORD=postgres
# 数据库名称
DB_DATABASE=buildingai
# 自动同步数据库(生产环境请勿开启)
DB_SYNCHRONIZE=false
# 自动同步数据库(开发环境)
DB_DEV_SYNCHRONIZE=true
# 是否记录数据库日志
DB_LOGGING=true
# Redis
# Redis 主机
REDIS_HOST=localhost
# Redis 端口
REDIS_PORT=6379
# Redis 用户名
REDIS_USERNAME=
# Redis 密码
REDIS_PASSWORD=
# Redis 数据库
REDIS_DB=0
# Redis 最大重连次数
REDIS_MAX_RECONNECT_ATTEMPTS=5
# Redis 重连延迟
REDIS_RECONNECT_DELAY=3000
# Cache
# 缓存过期时间
CACHE_TTL=86400
# 缓存最大项数
CACHE_MAX_ITEMS=1000
# Logs
# "log" | "error" | "warn" | "debug" | "verbose" | "fatal"
# 日志级别
LOG_LEVELS=error,warn,debug,fatal
# 写入日志级别
LOG_WRITE_LEVELS=error,warn,debug,fatal,log
# 是否写入日志
LOG_TO_FILE=true
# 是否打印数据库结构
LOG_DATABASE_SCHEMA=false
# 日志清理间隔
LOG_CLEAN_INTERVAL=3
# Web
# 开发环境前端地址
VITE_DEVELOP_APP_BASE_URL=http://localhost:4090
# if you deploy to production, please set this to real url
VITE_PRODUCTION_APP_BASE_URL=
# 前端 API 前缀
VITE_APP_WEB_API_PREFIX=/api
# 后端 API 前缀
VITE_APP_CONSOLE_API_PREFIX=/consoleapi
# Docker
# NPM 镜像地址
NPM_REGISTRY_URL=https://registry.npmmirror.com
# Docker 容器后缀
DOCKER_CONTAINER_SUFFIX=
# Docker 内存限制
DOCKER_MEMORY_LIMIT=6144M
# Docker CPU 限制
DOCKER_CPU_LIMIT=2.0
# Docker 内存保留
DOCKER_MEMORY_RESERVATION=512M
# This option will make the database and Redis ports in the Docker container fixed.
# 固定数据库端口
POSTGRES_EXTERNAL_PORT=
# 固定 Redis 端口
REDIS_EXTERNAL_PORT=

启动服务#

数据库实体会自动同步,无需单独操作

一键启动所有服务#

cd /BuildingAI
pnpm start

单独启动服务#

# 单独启动server
cd /BuildingAI/packages/api
pnpm dev
# 单独启动web
cd /BuildingAI/packages/web/buildingai-ui
pnpm dev

访问地址#

本地部署访问地址:http://localhost:4090
修改于 2026-01-05 01:59:07
上一页
Docker方式安装
下一页
功能使用教程
Built with