# 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](./README.md) - [中文](./README.zh.md)   ## Introduction ### [TeamIM](./modules/team/readme.md) - Multi-level organizational structure - Role management - Permission management - ... ### [Customer Service](./modules/service/readme.md) - Support multiple channels - multiple routing strategies, and detailed assessment indicators - Seating workbench - ... ### [Knowledge Base](./modules/kbase/readme.md) - Internal Docs - HelpCenter - FAQ ### [Ticket](./modules/ticket/readme.md) - Ticket management - Ticket SLA management - Ticket statistics and reports - ... ### [AI Chat](./modules/ai/readme.md) - Chat with Ollama/DeepSeek/ZhipuAI/... - Chat with Knowledge base(RAG) - Function calling - Mcp ### [Voice Of Customer](./modules/voc/readme.md) - feedback - survey - ... ### [project kanban](./plugins/kanban/readme.md) - todo list - daily/weekly report - statistics - ... ### workflow - form - process - ticket process - ... ### [Social Group](./modules/social/readme.md) - 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 ```bash 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 ```bash ollama pull deepseek-r1:1.5b ollama pull qwen2.5:1.5b ``` ### method 2: run docker compose with ollama ```bash 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 ```bash 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` ```bash # disable Ollama chat SPRING_AI_OLLAMA_CHAT_ENABLED: false # disable Ollama embedding SPRING_AI_OLLAMA_EMBEDDING_ENABLED: false ``` #### stop container ```bash 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` ```bash # 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 ```bash 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 ```bash # please replace 127.0.0.1 with your server ip http://127.0.0.1:9003/ # open port: 9003, 9885 demo username: admin@email.com demo password: admin ``` - [online preview](https://www.weiyuai.cn/admin/) - [demo](https://demo.weiyuai.cn) ## Open Source Client - [desktop](https://github.com/Bytedesk/bytedesk-desktop) - [mobile](https://github.com/Bytedesk/bytedesk-mobile) ## Open Source Demo + SDK | Project | Description | Forks | Stars | |-------------|-----------------------|----------------|-------------------| | [iOS](https://github.com/bytedesk/bytedesk-swift) | iOS |  |  | | [Android](https://github.com/bytedesk/bytedesk-android) | Android |  |  | | [Flutter](https://github.com/bytedesk/bytedesk-flutter) | Flutter | |  | | [UniApp](https://github.com/bytedesk/bytedesk-uniapp) | Uniapp |  |  | | [Web](https://github.com/bytedesk/bytedesk-web) | Vue/React/Angular/Next.js/JQuery/... |  |  | | [Wordpress](https://github.com/bytedesk/bytedesk-wordpress) | Wordpress |  |  | | [Woocommerce](https://github.com/bytedesk/bytedesk-woocommerce) | woocommerce |  |  | | [Magento](https://github.com/bytedesk/bytedesk-magento) | Magento |  |  | | [Prestashop](https://github.com/bytedesk/bytedesk-prestashop) | Prestashop |  |  | | [Shopify](https://github.com/bytedesk/bytedesk-shopify) | Shopify |  |  | | [Opencart](https://github.com/bytedesk/bytedesk-opencart) | Opencart |  |  | | [Laravel](https://github.com/bytedesk/bytedesk-laravel) | Laravel |  |  | | [Django](https://github.com/bytedesk/bytedesk-django) | Django |  |  | ## Links - [Download](https://www.weiyuai.cn/download.html) - [Docs](https://www.weiyuai.cn/docs/)