Skip to content
jack ning edited this page Jun 15, 2026 · 4 revisions

Bytedesk Wiki

Bytedesk 是一个面向企业客服、团队协作、知识库、工单和 AI Agent 场景的多模块平台。当前 wiki 用于补充主仓库 README,提供更适合研发、部署和维护团队快速查阅的结构化文档入口。

从这里开始

  • 快速开始:5 分钟了解项目定位、技术栈和本地启动路径
  • 部署指南:Docker 组合启动、典型场景和上线前检查
  • 开发指南:后端、前端、文档站的开发方式与常用命令
  • 项目结构:Monorepo 目录说明与模块分层
  • 模块地图:核心模块、插件、渠道与扩展点
  • 架构概览:运行时组件、依赖关系和关键集成点

项目摘要

  • 后端基于 Java 21、Spring Boot 3.5、Maven 多模块构建
  • 前端位于独立的 pnpm + Turborepo 工作区,整合管理后台、客户端和访客端
  • 部署支持 MySQL、PostgreSQL、Oracle、KingbaseES,消息队列支持 Artemis 和 RabbitMQ
  • 场景覆盖标准客服、无 AI 部署、呼叫中心、WebRTC 音视频客服以及组合场景
  • 项目同时维护独立 docs 站点,本 wiki 更侧重仓库使用、维护和贡献协作

建议阅读顺序

  1. 首次接触项目:先看 快速开始项目结构
  2. 计划本地运行:继续看 部署指南开发指南
  3. 需要定位业务能力:查看 模块地图
  4. 需要评估系统边界和依赖:查看 架构概览

相关入口

  • 主仓库 README:聚焦产品介绍、截图和对外资源
  • deploy/docker/readme.zh.md:最完整的 Docker 启动参数说明
  • frontend/README.md:前端工作区命令与 Node 版本要求
  • docs/README.zh.md:文档站构建与多语言维护说明

维护原则

  • 优先写“如何开始、如何定位、如何决策”,少写与源码重复的低价值抄录
  • 优先记录默认路径、推荐组合和常见场景,降低首次上手成本
  • 当主仓库启动命令、模块边界或依赖矩阵变化时,优先更新本 wiki 首页与对应专题页

Bytedesk Wiki

Getting Started

Core Documentation

Development & Deployment

External Links

Clone this wiki locally