diff --git a/README.md b/README.md index 4a5efc5..3ae0282 100644 --- a/README.md +++ b/README.md @@ -288,13 +288,12 @@ cd web && npx tsc --noEmit --- -## 设计稿与需求 +## 相关文档 -`docs/` 下保留各页面 HTML 原型与需求说明: - -- `docs/spec/` 开发需求 -- `docs/agent/` 租户端页面 -- `docs/admin/` 平台端页面 +- **[访客端对接与嵌入指南](docs/INTEGRATION_GUIDE.md)**(外部网站/SPA/App 快速集成 Widget) +- `docs/spec/` 开发需求与原型 +- `docs/agent/` 租户坐席端页面 +- `docs/admin/` 平台管理端页面 --- diff --git a/deploy/.env.prod.example b/deploy/.env.prod.example index 7cc6810..e29fc2c 100644 --- a/deploy/.env.prod.example +++ b/deploy/.env.prod.example @@ -21,6 +21,11 @@ DB_USER=kefu DB_PASSWORD=请改成强密码 DB_NAME=kefu_cloud DB_SSLMODE=disable +# 数据库连接池(可选,默认 50/10/60m/15m) +# DB_MAX_OPEN_CONNS=50 +# DB_MAX_IDLE_CONNS=10 +# DB_CONN_MAX_LIFETIME_MINUTES=60 +# DB_CONN_MAX_IDLE_MINUTES=15 # ========== JWT(deploy.sh 可自动生成)========== JWT_SECRET=请改成随机长字符串 diff --git a/docker-compose.prod.yml b/docker-compose.prod.yml index 0838cbc..4936329 100644 --- a/docker-compose.prod.yml +++ b/docker-compose.prod.yml @@ -98,6 +98,10 @@ services: DB_PASSWORD: ${DB_PASSWORD} DB_NAME: ${DB_NAME:-kefu_cloud} DB_SSLMODE: ${DB_SSLMODE:-disable} + DB_MAX_OPEN_CONNS: ${DB_MAX_OPEN_CONNS:-50} + DB_MAX_IDLE_CONNS: ${DB_MAX_IDLE_CONNS:-10} + DB_CONN_MAX_LIFETIME_MINUTES: ${DB_CONN_MAX_LIFETIME_MINUTES:-60} + DB_CONN_MAX_IDLE_MINUTES: ${DB_CONN_MAX_IDLE_MINUTES:-15} JWT_SECRET: ${JWT_SECRET:?请设置 JWT_SECRET} CORS_ALLOW_ORIGINS: ${CORS_ALLOW_ORIGINS:-*} STORAGE_ENDPOINT: minio:9000 diff --git a/docs/INTEGRATION_GUIDE.md b/docs/INTEGRATION_GUIDE.md new file mode 100644 index 0000000..f8ef040 --- /dev/null +++ b/docs/INTEGRATION_GUIDE.md @@ -0,0 +1,212 @@ +# 在线客服 Web 端接入指南 + +本文档面向接入在线客服的网站开发与运维人员,帮助您在 1 分钟内将客服系统集成至您的企业官网、电商商城、Web 业务系统或单页应用(SPA)中。 + +--- + +## 1. 接入前准备 + +您只需要向客服系统管理员获取一个专属的 **渠道标识(Channel Key)**: + +| 参数 | 说明 | 示例 | +| :--- | :--- | :--- | +| **服务地址** | 客服系统统一入口 | `https://cloud.400cc.cn/` | +| **渠道标识(data-id)** | 您企业专属的渠道密钥 | `WK_8a3f2e` | + +> 💡 **获取方式**:登录客服工作台 -> 左侧菜单「系统设置」 -> 「渠道管理」 -> 复制您渠道的专属代码(其中的 `data-id` 即为您的 Channel Key)。 + +--- + +## 2. 快速接入(标准网页 / HTML) + +只需在您网站 HTML 页面的 `
+ + + + + + +