入门
免费私有化部署 👈
免费在线使用(快速上手指引)
详细使用说明书(功能介绍) 📔
集成到您的网站、APP或公众号

检查单(部署遇到问题请对照检查)


如果部署完成遇到故障,无法登录使用,请先对照此检查单进行检查。

请务必逐条对照检查,不要有“这个肯定没问题,不用看”的想法,以免走弯路浪费时间。


运行环境

  • 服务器是否部署在中国大陆以外的其它国家或地区,那么从中国大陆登录客服端进行连接,可能会容易掉线。客服端使用的是 TCP/IP 长连接,需要稳定的网络连接。以香港服务器为例,不管是阿里、亚马逊、微软都无法稳定的长连接,且网络一般都比较慢。而一些二线服务商的服务器反而有可能可以提供更稳定和更高速的连接,需要在部署前测试确认清楚。
  • 是否使用了网络代理,VPN?不稳定的网络代理工具会出现容易掉线现象,先去除代理测试。
  • 是否部署了高防或CDN?先将之去除,客服系统稳定运行确定客服系统正常后再考虑部署其它网络组件。
  • 对于集成在网站中使用的场景,主网站是 https 吗?那么客服系统所在域名(kf-api 和 kf-resource)也必须是 https。
  • 服务端各目录(Server、Resource)路径是否有足够的访问和执行权限?Windows Server 请勿把目录放在桌面;Linux 也需检查存储目录的权限设置。
  • 站点 IP 地址绑定是否正确?IIS 中配置站点时,默认不需要绑定 IP 地址。参阅:配置服务器主程序

服务器主程序

  • 提示 HTTP Error 500.30 - ANCM In-Process Start Failure 。检查是否正确安装了 .Net Core。如果是 Windows 服务器,请在安装后重新启动 IIS 服务。如果是 Linux 服务器,请重新启动主程序进程。
  • 如果主程序部署在 IIS 中,务必取消回收策略和闲置时间回收,参阅:配置服务器主程序
  • 检查配置文件,找到“Server”目录下的“appsettings.json”并用记事本打开。
    • 数据库连接 DatabaseEngineDefaultConnection 配置是否正确。如果数据库服务器部署于同一台服务器,连接地址请使用 localhost
    • 使用数据库管理工具测试数据库连接串在服务器上是否能够正常连接数据库,也可使用自动化配置工具进行测试。
    • Environment 节点下的 服务器IP、端口、域名 是否配置正确。
      TcpIpAddress 必须是服务器的公网 IP 地址,不能是 localhost 或其它别名,客服端软件通过此 IP 地址建立长连接。
    • 修改配置后是否重启了 “Server” 站点,除了 “站点” 外,“应用程序池”是否已经重启。

注意:appsettings.json 文件修改之后,必须重启服务端主程序才可以生效。

  • IIS:
    重启站点和应用程序池。
  • Linux:
    执行:systemctl restart kfServer.service
  • 宝塔面板:
    Supervisor 管理器中重新启动 Server 进程。

资源站点

  • 如果被嵌入客服系统的目标页面无法显示嵌入式小聊天窗口,检查:
    • 被嵌入客服系统的目标页面(您的网站页面)是否已经部署在服务器,并通过 http 或 https 协议访问。
    • 加载方式配置为“自动”还是“手动”。如果选择“手动”,则必须通过 js 脚本在页面中自行载入客服系统。参阅:传递您的访客数据到客服系统
  • 访客端没有使用 WebSocket 进行通信:如果部署于 IIS,检查 IIS 是否开启了 WebSocket 功能(参阅:安装 IIS),如果部署于 Nginx ,检查配置文件是否打开了 WebSocket 功能(参阅:Linux 配置服务器主程序宝塔 配置服务器主程序)。
  • 浏览器访问时报 401 未授权错误。
    在 IIS 中选中站点,然后双击右侧的“身份验证”。选中“匿名身份验证”,点击右侧的“启用”将设置为“已启用”状态。然后点击右侧的“编辑”,选中“应用程序池标识”,然后点击确定。回到浏览器中,按 Ctrl + F5 强制刷新页面。
  • 检查配置文件:找到“embedded.js”和“WebChat/Config.js”,并用记事本打开。
    • 配置服务器连接地址各个参数是否配置正确。
    • 所使用的连接协议,是 http 还是 https ,配置正确。
  • 是否清除了缓存
    • 修改配置后是否重启了 “Resource” 站点。
    • 访客端是否强制刷新(Ctrl + F5)或清除了缓存。

参阅:资源站点配置文件修改维护说明

Web 管理后台

  • 弹出 404 接口调用失败。检查配置文件是否正确配置,各访问地址是否加上了“http://”或“https://”协议头,完成配置后在浏览器上按 Ctrl +F5 强制刷新。
    参阅:Web 管理后台配置文件修改维护说明
  • 浏览器访问时报 401 未授权错误。
    在 IIS 中选中站点,然后双击右侧的“身份验证”。选中“匿名身份验证”,点击右侧的“启用”将设置为“已启用”状态。然后点击右侧的“编辑”,选中“应用程序池标识”,然后点击确定。回到浏览器中,按 Ctrl + F5 强制刷新页面。

客服端软件

  • 是否在登录界面点击“修改”配置了正确的服务器主程序地址。
  • 登录界面没有“修改”按钮不能修改服务器主程序地址。因为使用的客服程序版本不正确,私有化部署版与官方版不同,请使用私有化部署包中“Shell”目录提供的客服程序,参阅:配置发布客服端程序
  • 登录时提示版本不正确,检查数据库信息中记录的版本与实际使用的版本是否一致,参阅:升级数据库中的信息
  • 登录时提示没有返回版本信息,是因为在配置服务器主程序后,没有初始化数据。请查阅 配置服务器主程序 的结尾部分。
  • 登录时提示“不允许对非连接的套接字执行此操作”:
    • 请检查服务器的防火配置,将客服系统使用的通信规则添加到入站规则,参阅:准备操作系统
    • 检查云服务器提供商后台安全功能,是否开放了客服程序所需通信端口。如阿里云需要在安全组功能中开放端口。
    • 检查服务端主程序配置文件 appsettings.json 中的 TcpIpAddress 是否正确配置为服务器外网 IP 地址。

服务器配置

  • 客服程序所使用的 TCP 端口是否已经开放,默认是 9527。
    私有化部署在免费使用时,通信端口固定为 9527,请勿配置其它端口号。付费授权允许自定义通信端口。
  • 不要占用 5000 端口,该端口用于服务端程序反向代理。
  • 防火墙是否打开了所需使用的端口,如果使用的是公有云服务器,除了要在操作系统中打开防火墙端口之外,还需要在公有云后台的防火墙中做相应的配置。
  • 所需的基础中间件是否已经安置配置,
    参阅:Windows 服务器Linux 服务器
  • 如果使用的是 IIS,主程序配置文件修改后是否重新启动了 IIS 站点和应用程序池。
  • 如果使用的是 nginx ,修改 nginx 配置文件后是否已经重新加载。

使用命令行检查服务器主程序

  • 使用命令行进入 Server 目录,执行:dotnet Sheng.Linkup.Server.dll,如果服务器主程序不能正确启动,将输出提示信息,可根据提示信息进一步排查。

    在 Windows Server 中使用 Command Prompt 或 Windows PowerShell
    在 Linux 中直接在控制台执行

    • 如果提示信息中出现 SQL、MySQL 字样,可能是数据库连接没有配置好,检查是否正确创建了数据库;是否正确创建了表结构;数据库连接串在服务器上是否可用。如果数据库与服务端程序部署在同一台服务器,则数据库连接串中的地址应使用 localhost
    • 如果提示信息中出现 System.IO.IOException: Failed to bind to address http://127.0.0.1:5000: address already in use ,表示 5000 端口被占用,请占用该端口,该端口用于服务端程序反向代理。

若依然不能解决故障,可与我联系,不收费。

All Rights Reserved. 曹旭升 版权所有

E-mail:cao.silhouette@msn.com,来信必复

Skype:live:cao.silhouette,微信:sheng-incog

@南京

关于我 我的产品 我的开源项目

ICP证:皖ICP备14020687号-1

公安备案:34110202000256