Rocket.Chat.Electron

Rocket.Chat桌面应用

Rocket.Chat的桌面应用程序可用于MacOS，Windows和Linux使用Electron。

---

与我们互动

分享你的故事

我们很想听听您的经历，并可能在我们的博客上介绍它。

订阅更新

每月一次，我们的营销团队发布了一封电子邮件更新，其中包含有关产品发行，相关主题，事件和用例的新闻。报名！

---

下载

您可以从“版本”页面下载最新版本。

安装

启动安装程序并按照说明进行安装。

Windows选项

在Windows上，您可以通过添加/S标志来运行无声安装。您还可以添加以下选项：

• /S静音安装
• /allusers为所有用户安装（需要管理员）
• /currentuser仅安装当前用户（默认）
• /disableAutoUpdates禁用自动更新

发展

快速开始

先决条件：

• git
• node.js
• 节点gyp
• 建议使用纱线代替NPM。

现在只需克隆并启动应用程序：

git clone https://github.com/RocketChat/Rocket.Chat.Electron.git
cd Rocket.Chat.Electron
yarn
yarn start

项目结构

源位于src文件夹中。在运行yarn start的应用程序时，将自动构建此文件夹中的所有内容。

构建过程从src文件夹中编译所有内容，并将其放入app文件夹中，因此，在构建完成后，您的app夹包含完整的可运行的应用程序。

打字稿

随着Rocket.Chat Codebase的持续更改，该应用程序在Typescript 4中重写，以解决有关可维护性的问题。

构建管道

构建过程建立在Rollup Bundler上。您的代码有三个条目文件：

• src/main.ts ，在主电子过程中运行的脚本，编排整个应用程序；

• src/rootWindow.ts ，呈现root窗口UI的脚本，应用程序的主窗口；

• 和src/preload.ts ，以特权模式运行以连接该应用程序和WebViews Rendering Rocket.Chat的Web客户端。

添加node.js模块

请记住要尊重package.json文件中的dependencies和devDependencies之间的分裂。 dependencies中列出的模块只能包含在可分布的应用中。

故障排除

节点gyp

请按照节点GYP读数的安装说明进行操作。

Ubuntu

您需要安装以下软件包：

build-essential
libevas-dev
libxss-dev

软呢帽

您需要安装以下软件包：

libX11
libXScrnSaver-devel
gcc-c++

Windows 7

在Windows 7上，您可能必须遵循节点GYP安装指南的选项2并安装Visual Studio。

测试

单位测试

yarn test

我们使用Jest Electron Runner使用开玩笑的测试框架。它搜索匹配Glod模式 *的src目录中的所有文件*.(spec|test).{js,ts,tsx} 。

发行

将您的应用程序包装到安装程序使用命令中：

yarn release

它将启动您正在运行此命令的操作系统的包装过程。准备发行文件将输出到dist目录。

所有包装动作均由电子构建器处理。它具有许多自定义选项。

默认服务器

servers.json文件将定义客户端将要连接到的服务器，并将填充侧栏中的服务器列表。它包含一个默认服务器列表，该默认服务器将在用户首次运行应用程序（或从列表中删除所有服务器时）时添加。文件语法如下：

{
  "Demo Rocket Chat" : " https://demo.rocket.chat " ,
  "Open Rocket Chat" : " https://open.rocket.chat "
}

预释放配置

您可以将servers.json与安装软件包捆绑在一起，文件应位于项目应用程序的根部（与package.json相同的级别）。如果找到该文件，将跳过初始“连接到服务器”屏幕，并尝试连接到已定义的数组中的第一个服务器，并在登录屏幕上直接删除用户。请注意，即使没有添加其他服务器，即使您在不删除较旧的首选项的情况下卸载了该应用程序，也不会再次触发该servers.json程序。

后安装配置

如果您不能（或不想）将文件捆绑在应用程序中，则可以在用户首选项文件夹中创建一个servers.json 。将覆盖包装的文件夹。该文件应位于%APPDATA%/Rocket.Chat/ folder或安装文件夹中，以防所有用户安装（仅Windows）。

对于Windows，完整的路径是：

• ~Users<username>AppDataRoamingRocket.Chat
• ~Program FilesRocket.ChatResources

在MacOS上，完整的路径是：

• ~/Users/<username>/Library/Application Support/Rocket.Chat/
• /Library/Preferences/Rocket.Chat/

在Linux上，完整的路径是：

• /home/<username>/.config/Rocket.Chat/
• /opt/Rocket.Chat/resources/

覆盖设置

您可以通过在用户首选项文件夹中创建一个overridden-settings.json来覆盖用户设置。该文件应位于%APPDATA%/Rocket.Chat/ folder或安装文件夹中，以防所有用户安装（仅Windows）。

文件上的每个设置都将覆盖默认设置和用户设置。然后，您可以使用它来禁用默认功能，例如自动更新，甚至创建单个服务器模式。

可以覆盖的设置是：

环境	描述
"isReportEnabled": true,	设置如果将错误报告给开发人员。
"isInternalVideoChatWindowEnabled": true,	设置视频通话将在内部窗口中打开。
"isFlashFrameEnabled": true,	设置如果将启用闪存框架。
"isMinimizeOnCloseEnabled": false,	设置如果将应用程序最小化，请关闭。
"doCheckForUpdatesOnStartup": true,	设置该应用程序是否会在启动上检查更新。
"isMenuBarEnabled": true,	设置如果将启用菜单栏。
"isTrayIconEnabled": true,	启用托盘图标，该应用将隐藏在托盘上。覆盖"isMinimizeOnCloseEnabled"
"isUpdatingEnabled": true,	设置如果用户可以更新该应用程序。
"isAddNewServersEnabled": true,	设置如果用户可以添加新服务器。

单个服务器模式

如果设置"isAddNewServersEnabled": false设置了，则用户将无法添加新服务器。按钮和快捷方式将被禁用。然后，您将必须将服务器添加到servers.json文件中。这样，您可以创建一个单个服务器模式，或者只是不要让用户自己添加新服务器。

示例配置

overridden-settings.json文件：

 {
   "isTrayIconEnabled": false,
   "isMinimizeOnCloseEnabled": false
}

当启用isTrayIconEnabled时，该应用将隐藏在关闭上。当启用isMinimizeOnCloseEnabled时，该应用将在关闭时最小化。两者都被禁用时，该应用将在关闭时退出。

执照

根据MIT许可发布。