Bytedesk - Chat as a Service

AI powered Omnichannel customer service With Team IM

Language: English | 中文 | Demo

Admin Dashboard

Admin Chat

Admin LLM+Agent

Admin Channel

Agent

Introduction

TeamIM

Multi-level organizational structure
Role management
Permission management
...

Customer Service

Support multiple channels
multiple routing strategies, and detailed assessment indicators
Seating workbench
...

Ticket

Ticket management
Ticket SLA management
Ticket statistics and reports
...

AI Agent

Chat with Ollama/DeepSeek/ZhipuAI/...
Chat with Knowledge base(RAG)
Function calling
Mcp

Call Center

Professional call platform based on FreeSwitch
Supports incoming call pop-up screens, automatic allocation, and call recording
Data statistics, seamless integration of voice and text services

Video Customer Service

High-definition video calls based on WebRTC technology
Supports one-click video conversations and screen sharing
Suitable for service scenarios requiring intuitive demonstrations

Open Platform

Provides complete RESTful API interfaces and SDK toolKits
Supports seamless integration with third-party systems for data interoperability
Multi-language SDK support to simplify development and integration processes

Quick Start

Option 1: Docker Compose Only (Quick Verification)

If you only want to quickly start and verify the project with Docker, without downloading the full source code, just clone the standalone deployment repository bytedesk-docker-compose:

git clone https://github.com/Bytedesk/bytedesk-docker-compose.git
cd bytedesk-docker-compose
# create .env
cp .env.example .env
# default startup (MySQL + Artemis, middleware + bytedesk app image)
./start.sh

Note: all (the default) starts the middleware plus the bytedesk app image — i.e. redis + elasticsearch + MySQL + Artemis + bytedesk — which is what you want for quick verification. middleware only starts the middleware (redis + elasticsearch + the selected DB + MQ, no bytedesk image) and is intended for local development running bytedesk from source code. See deploy/docker/readme.md for the full keyword reference.

The bytedesk-docker-compose repository contains exactly the same content as the deploy/docker folder of this repository and is kept in sync. It lets you start and verify the project by downloading only the Docker image configuration files, without cloning the entire monorepo.

Option 2: Full Repository

git clone https://github.com/Bytedesk/bytedesk.git
cd bytedesk/deploy/docker
# create .env
cp .env.example .env
# default startup (MySQL + Artemis + standard, middleware only)
./start.sh mysql artemis standard middleware

For more startup/stop combinations (PostgreSQL, Oracle, RabbitMQ, noai, webrtc, call, full stack), see docker readme (also available in the bytedesk-docker-compose repository).

# Please replace 127.0.0.1 with your server IP
Access address: http://127.0.0.1:9003/
Default account: [email protected]
Default password: admin

Project Structure

Monorepo powered by Maven (root pom.xml) with multiple modules and deploy assets.

bytedesk/
├─ channels/           # Channel integrations (douyin, shop, social, wechat)
├─ demos/              # Example projects and sample code
├─ deploy/             # Deployment assets: docker, k8s, server configs
├─ enterprise/         # Enterprise features (ai, call, core, kbase, service, ticket)
├─ images/             # Images used in docs and UI previews
├─ jmeter/             # Performance tests and scripts
├─ logs/               # Runtime logs (local/dev)
├─ modules/            # Core product modules (TeamIM, Service, KBase, Ticket, AI, ...)
├─ plugins/            # Optional plugins (freeswitch, webrtc, open platform)
├─ projects/           # Custom projects or extensions
├─ starter/            # Starters/entry points

architecture

Open Source Client

Open Source Demo + SDK

Project	Description	Forks	Stars
iOS	iOS
Android	Android
Flutter	Flutter
UniApp	Uniapp
Web	Vue/React/Angular/Next.js/JQuery/...
Wordpress	Wordpress
Woocommerce	woocommerce

License

Licensed under GNU AFFERO GENERAL PUBLIC LICENSE(AGPL v3) (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.gnu.org/licenses/agpl-3.0.html

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Terms of Use

Allowed Uses: Can be used for commercial purposes, but prohibited from resale without prior permission, and the logo and copyright information must not be removed or replaced without permission
Prohibited Uses: Strictly prohibited for use in illegal and non-compliant businesses including trojans, viruses, pornography, gambling, fraud, and other illegal activities
Disclaimer: This software does not guarantee any form of legal liability. Users are responsible for their own usage risks

GeezerVison

bytedesk.com Bytedesk

Achievements