Skip to main content

JAR Package Deployment

Tip
  • Operating System: Ubuntu 20.04 LTS
  • Server Requirements: Minimum 2 cores 4GB RAM, Recommended 4 cores 8GB RAM

Dependencies​

Download​

# Download JAR package
wget https://github.com/bytedesk/bytedesk/releases/download/v1.0.0/bytedesk.jar
java --version
# java 17.0.4 2022-07-19 LTS

MySQL 8.0​

MySQL is used by default

# Modify application.properties
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/bytedesk_im
spring.datasource.username=root
spring.datasource.password=password

Or PostgreSQL 16​

Choose either MySQL or PostgreSQL, MySQL is used by default

# Modify application.properties
spring.datasource.url=jdbc:postgresql://127.0.0.1:5433/bytedesk_im
spring.datasource.username=postgres
spring.datasource.password=password

Redis​

spring.data.redis.database=0
spring.data.redis.host=127.0.0.1
spring.data.redis.port=6379
spring.data.redis.password=password

Nginx​

Not required for local deployment, only recommended for production environment where Nginx serves as reverse proxy.

AI​

Optional, only used for knowledge base Q&A, can be skipped. If only using AI model for conversation, just fill in Zhipu AI key in configuration file.

Download link: https://github.com/Bytedesk/bytedesk-ai

Download IM Server​

# More downloads: https://www.weiyuai.cn/download
# Extract
unzip weiyu-server.zip

Configuration​

# Edit configuration file: server/config/application.properties
# Modify database connection info
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/bytedesk_im
spring.datasource.username=root
spring.datasource.password=password
# Modify redis connection info
spring.data.redis.database=0
spring.data.redis.host=127.0.0.1
spring.data.redis.port=6379
spring.data.redis.password=password

# Grant permissions
chmod +x start.sh
chmod +x stop.sh
# Start
# Run on Mac or Linux
./start.sh
# Run on Windows
start.bat
# Stop
# Run on Mac or Linux
./stop.sh
# Run on Windows
stop.bat
# After starting, wait a moment. Check port, if port 9003 exists, startup successful
netstat -ntlp
# View logs
tail -f logs/bytedeskim.log

Local Preview​

web: http://127.0.0.1:9003/
Developer portal: http://127.0.0.1:9003/dev
Admin dashboard: http://127.0.0.1:9003/admin, username: admin@email.com, password: admin
Agent client: http://127.0.0.1:9003/agent/chat, username: admin@email.com, password: admin
Visitor: http://127.0.0.1:9003/chat?org=df_org_uid&t=0&sid=df_ag_uid&
API docs: http://127.0.0.1:9003/swagger-ui/index.html
Database monitor: http://127.0.0.1:9003/druid, username: admin@email.com, password: admin
Actuator: http://127.0.0.1:9003/actuator