Question

禅道客户端由喧喧提供支持。

喧喧是一款安全的IM产品，支持私有部署，跨平台操作，内置大量插件，功能丰富。

禅道集成客户端后，可以进行成员沟通、小组讨论、文件传输、任务指派等，实现更加方便的项目管理和更加流畅的团队协作。

可观看视频了解操作详情：https://www.zentao.nethttps://www.zentao.net/redirect-index-21795.html

一、 配置禅道客户端服务器参数

以 Windows 64位一键安装包为例。

点击ZenTao.exe程序启动禅道。

确认下xampp/runner/res/apache/conf/httpd.conf配置文件中，是否存在x.php的配置文件。如果不存在，需要添加如下内容。

  <Files "x.php">
    SetHandler application/x-httpd-php
  </Files>
  <Files "ux.php">
    SetHandler application/x-httpd-php
  </Files>

检查好后，去“后台”-“系统设置”-“首页”进行参数设置。

注意：禅道服务器地址为完整的协议+地址+端口，如http://192.168.1.35 或 http://pms.zentao.com ，不能使用127.0.0.1。

• 禅道的客户端集成默认是开启的状态。

• 密钥是随机生成的32位密码，需要与禅道客户端的服务器里的配置保持一致。

• 上传文件大小默认是20M，可以根据实际使用需要调整。

• 是否启用https，默认是不启用。启用后，需要把https证书的内容和密钥复制粘贴到输入框了。

二、下载和运行禅道客户端的服务器

设置好客户端参数后，会出现下载客户端服务器的按钮。

注：

• 选择操作系统，目前支持 Windows 32位，Windows 64位，Linux 32位，Linux 64位，macOS系统。
• 如果之前已下载过喧喧服务端，那么可以只下载配置文件。配置文件为xxd.conf，下载成功后替换掉原喧喧服务器端里的同名文件即可。替换后需要重启服务器端服务。

将下载后得到文件中包含之前在“后台”-“客户端”下所做的配置参数。

如在config/xxd.conf文件中，可以修改上传文件大小的设置。

双击目录中的 xxd.exe ，即可启用服务器端的服务。

说明：

禅道客户端的服务器端（xxd）

• 禅道和 xxd在同一服务器：登录禅道客户端时，服务器地址写禅道访问地址也没问题。
• 禅道和 xxd不在同服务器：登录禅道客户端时，服务器地址必须写 xxd 的监听地址。
• xxd 的监听地址为内网地址，但连接时要用外网IP连接。 登录禅道客户端时，服务器地址要写外网地址。
• xxd 安装在云主机外网时，一定要在防火墙开放11444和11443的监听端口访问。

禅道客户端的服务器端(xxd)推荐放置位置

• 源码方式安装的禅道，推荐把 xxd 放到与禅道并行的目录，执行 ./xxd 即可启动运行禅道客户端的服务器端服务（xxd）。

• Windows一键安装包方式安装的禅道，可以在禅道“后台”-“客户端”-“参数设置"中只下载配置文件xxd.conf，然后覆盖原目录里的 xampp/xxd/config 即可。启动 xxd 服务，直接点击禅道运行控制面板里的“启动聊天服务”即可。

• Linux 一键安装包安装的禅道，可以在禅道“后台”-“客户端”-“参数设置"中只下载配置文件xxd.conf，然后覆盖原目录里的 /opt/zbox/run/xxd/config 即可。

三、安装和登录禅道客户端

超级管理员在后台配置了客户端服务器端后，才会出现“下载客户端”的入口。

内网环境需要手动将禅道客户端的安装包放到服务器指定目录下，这样其他用户才可以通过“下载客户端”入口下载禅道客户端，操作可参见 4. 内网环境下载禅道客户端。

禅道地盘首页点击个人头像-“客户端”-“下载客户端”。

选择操作系统，点击“保存”，进入下载页面。

禅道客户端下载成功后，解压得到zentao_chat_client.win64文件夹。进入 zentaoclient 目录，双击 zentaoclient.exe 即可启动禅道客户端。

点击“”显示服务器设置“。

注：

• 服务器填写的是客户端服务器端设置文件（xxd.conf）里的服务器地址。
• 如果没有单独修改xxd配置文件中的默认端口号，服务器地址后面 不需要加端口。 例如：禅道在网页端访问地址为http://192.168.1.110:8080，在客户端的服务器填写http://192.168.1.110就可以了。
  
• 账号和密码，填写的是禅道里添加的用户名和密码。

客户端登录失败排查

1. 请先逐一排查禅道、禅道客户端、禅道客户端服务器端（xxd）是否都正常运行。
2. 禅道、禅道客户端、禅道客户端服务器端（xxd）都运行正常的话，需要检查禅道客户端服务器端的xxd.conf的配置。 服务器名是否写对，密钥是否一致，是否加上了default。
3. 禅道客户端登录页面提示：服务器操作失败，提示500错误。请先到“后台”-“客户端”-服务器设置里查看服务器配置里是否是打开状态。

四、内网环境下载禅道客户端

内网环境可以先从官网手动下载禅道客户端，然后放到指定的服务器目录下，其他用户就可以通过点击个人头像-“客户端”-“下载客户端”直接下载客户端了。

在禅道官网下载对应操作系统的安装包。

查看禅道所在目录下是否存在 www/data/client 目录。如果不存在，则创建此目录。明确客户端的版本，在client目录下创建一个以客户端版本号为名的目录，这里的客户端版本号为2.5.5，则在client下创建2.5.5目录。

将下载的客户端安装包放到刚才创建的2.5.5目录下，这样用户就可以下载客户端了。注意：Linux服务器需要注意文件权限和属组的设置。

五、使用禅道客户端

禅道客户端的基础使用，可以参考喧喧官网的《客户端使用说明》。

禅道和客户端集成后：

• 禅道内添加账户和密码共用；
• 禅道页面可以直接在客户端打开，浏览；
• 禅道里的操作可以通过客户端发送消息提醒；
  
• 客户端消息可以直接右键创建Bug、需求、任务、文档、待办；
  
• 客户端卡片形式显示禅道里Bug、需求、任务、文档、用例的详情页，并且提供操作按钮。

1. 使用禅道账号和密码登录

禅道客户端和禅道的账号和密码是通用的。使用禅道的用户名和密码即可登录禅道客户端。

• 禅道管理员配置好客户端的服务器，在禅道-“后台”-“人员”-“用户”里添加用户。
• 其他用户只要下载客户端，使用禅道账号和密码，就可以登录禅道客户端。

2. 客户端打开禅道页面

点击客户端左侧导航的禅道图标，直接在客户端里查看浏览禅道里的信息。

3.客户端消息提醒

管理员到禅道后台-“通知”-“设置”-“客户端”勾选需要发送提醒的操作。设置后，用户在禅道里进行这些操作，指派人就可以在客户端收到提醒。

以任务的指派为例。指派人的禅道客户端的通知中心里，会收到任务的指派信息。可以直接点击消息通知，查看任务的详情。当客户端最小化在右下角时，会有声音通知和信息提示。

4.消息右键创建Bug、需求、任务、文档、待办

点击禅道客户端内消息右键，支持直接创建禅道Bug、需求、任务、文档、待办。

注：管理员需要在禅道里分配了相应权限，用户才可以在禅道客户端里消息右键才可以进行创建。如果没有分配这些权限，那么客户端消息右键时，不会显示创建按钮。

例如，点击“创建待办”，即可在客户端内打开禅道，添加消息内容为待办。

5.客户端里卡片显示需求、任务、Bug、用例、文档的详情页

在客户端聊天对话框，可以直接发送禅道中的需求、任务、Bug、用例、文档详情页面地址。发送成功后，将以卡片形式显示。

6.客户端的群组聊天

点击“会话”按钮，可以选择用户创建讨论组。方便禅道中项目团队成员之间的沟通和协作。

六、全新禅道客户端和在线聊天功能

禅道16.0版本提供了全新的禅道桌面客户端，新增了在线聊天功能。

用户通过禅道客户端，在禅道web网页中与团队成员展开沟通协作，既可以高效沟通，又可以便捷地访问禅道功能模块。

禅道客户端和禅道web网页在线聊天的信息可以相互同步显示。
下面我们来简单介绍全新禅道客户端和在线聊天功能。
1.全新禅道客户端
禅道16.0及以上版本，在后台--客户端里集成客户端后，在个人用户中心--面板里下载禅道客户端。

启动xxd 服务，我们就可以使用全新的禅道客户端了。

全新的禅道客户端页面左侧上部导航显示的是禅道的左侧导航，点击可以直接访问到禅道对应的功能模块。

左侧下部导航显示了禅道客户端的通讯录、应用和聊天图标。

点击左下角的用户头像可以设置客户端，改变在线状态等操作。

点击到最近聊天，可以实时进行聊天、图片文件传输。

2.在线聊天功能

开启了禅道客户端后，可以在禅道页面右下角查看到客户端的聊天窗口图标。
配置成功了禅道客户端，且xxd 服务是开启状态，不登录禅道客户端，直接在禅道web页面即可实现在线聊天功能。

禅道页面右下角点击使用在线聊天功能

点击会话可以展开进行在线聊天。

3.禅道客户端和禅道web网页在线聊天信息的同步
禅道客户端信息和禅道web网页在线聊天的信息可以实现实时的同步。
如果是离线状态的话，客户端和web网页谁先登录就给谁发送离线消息。

也就是说客户端先登录，会提示离线消息，web网页后登录不显示离线消息，但是同步客户端消息。
禅道客户端页面信息展示：

禅道客户端中会卡片展示需求、任务、Bug等的详情页，还显示操作栏，可以直接操作。

禅道web页面在线聊天页面，信息与禅道客户端的保持一致。
禅道web页面直接显示禅道链接，点击可直接访问禅道页面中对应的页面信息。

4.禅道客户端音视频功能

禅道客户端的音视频功能是企业版和旗舰版才支持的功能。

开启了音视频功能，配置了音视频服务器，那么就可以使用禅道客户端进行一对一，群组的音视频会议。

先到后台--客户端--音视频，点击编辑，开启音视频功能，配置音视频服务配置。

开启和配置音视频服务器：

音视频服务器配置完成后，我们来设置视频的分辨率：

登录禅道客户端在群组和一对一会话窗口的右上角就会显示发起会议功能。

群组的话，还可以发起全员会议和选择成员开始会议。

发起音视频会议时，可以进行静音、开始视频、分享屏幕、查看参会成员。