Bytedesk - Chat as a Service

AI powered Omnichannel customer service With Team Cooperation

:::tip Bytedesk is still in the early stage of rapid iteration, the documentation may lag behind the development, resulting in possible functional descriptions that do not match the latest software version :::

Language

• English
• 中文

Introduction

TeamIM

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

Customer Service

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

Knowledge Base

• Internal Docs
• HelpCenter
• FAQ

Ticket

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

AI Chat

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

Voice Of Customer

• feedback
• survey
• ...

project kanban

• todo list
• daily/weekly report
• statistics
• ...

workflow

• form
• process
• ticket process
• ...

Social Group

• like Discord
• ...

Multi-tenant

• Multi-tenant management
• Tenant isolation
• Tenant statistics
• ...

Docker Quick Start

method 1: clone project and start docker compose container，need ollama

git clone https://github.com/Bytedesk/bytedesk.git && cd bytedesk/deploy/docker && docker compose -p bytedesk -f docker-compose.yaml up -d

ollama pull model

ollama pull deepseek-r1:1.5b
ollama pull qwen2.5:1.5b

method 2: run docker compose with ollama

git clone https://github.com/Bytedesk/bytedesk.git && cd bytedesk/deploy/docker && docker compose -p bytedesk -f docker-compose-ollama.yaml up -d

docker ollama pull model

docker exec ollama-bytedesk ollama pull deepseek-r1
docker exec ollama-bytedesk ollama pull qwen2.5:1.5b

if don't need ollama, you can change docker-compose.yaml or docker-compose-ollama.yaml

# disable Ollama chat
SPRING_AI_OLLAMA_CHAT_ENABLED: false
# disable Ollama embedding
SPRING_AI_OLLAMA_EMBEDDING_ENABLED: false

stop container

docker compose -p bytedesk -f docker-compose.yaml stop

change config, otherwise upload image, file and knowledge base cannot be displayed normally

• change docker-compose.yaml file or docker-compose-ollama.yaml

# please replace 127.0.0.1 with your server ip
BYTEDESK_UPLOAD_URL: http://127.0.0.1:9003
BYTEDESK_KBASE_API_URL: http://127.0.0.1:9003

method 3: run from source code

git clone https://github.com/Bytedesk/bytedesk.git && cd bytedesk && ./mvnw install -Dmaven.test.skip=true && cd starter && ./mvnw spring-boot:run

Preview

local preview

# please replace 127.0.0.1 with your server ip
http://127.0.0.1:9003/
# open port: 9003, 9885
demo username: [email protected]
demo password: admin

• online preview
• demo

Open Source Client

• desktop
• mobile

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
Magento	Magento
Prestashop	Prestashop
Shopify	Shopify
Opencart	Opencart
Laravel	Laravel
Django	Django

Links

• Download
• Docs