Rocket.Chat.Electron is a free, open source collaboration & communication project written in TypeScript and released under MIT. It has 1,707 GitHub stars, 848 forks and 207 open issues, and was last pushed 19 hours ago. On this registry it ranks #37 of 64 tracked projects in Collaboration & Communication, with 5 head-to-head comparisons available.

What is Rocket.Chat.Electron?

Rocket.Chat.Electron is the official desktop client for the Rocket.Chat communications platform on Windows, macOS, and Linux, built with Electron and TypeScript for end users who want all of their workspaces in one window and for IT teams that need to install and configure the app across many machines.

What it is

Rocket.Chat.Electron is the first-party desktop application for Rocket.Chat, distributed under the MIT licence and written in TypeScript with Electron and React. It lives in the Rocket.Chat ecosystem alongside the platform's web and mobile clients, and its README describes it as delivering everything in the Rocket.Chat web client plus desktop-specific behaviour: multiple workspaces in a single window, native system notifications, background operation, a dedicated video call window, and settings that administrators can enforce centrally.

The concrete thing it replaces is the Rocket.Chat web client running in a browser tab. A tab cannot put messages in the system tray, cannot offer inline quick reply from a Windows or macOS notification, and cannot be preconfigured or installed without user prompts. The project solves that second problem explicitly for organisations: it ships NSIS, MSI, PKG, and deb installers that support silent installation, and it reads two JSON files so that IT teams can preset workspaces and lock down behaviour on every device rather than asking each user to set the app up by hand.

Key capabilities

  • Multiple Rocket.Chat workspaces are added to a sidebar and switched between inside one application window.
  • Native system notifications include inline quick reply on Windows and macOS.
  • The app keeps running in the system tray or minimised so that messages are not missed.
  • Video calls open in a built-in app window instead of a browser tab.
  • Administrators preset workspaces with a servers.json file, which lets users skip the Connect to server screen and go straight to the login screen.
  • An overridden-settings.json file enforces settings such as disabling auto-update, hiding the tray icon, or turning off quick reply in notifications, and combining "isAddNewServersEnabled": false with servers.json stops users from adding workspaces.
  • Platform installers cover Windows 10 (x64, ia32, arm64) as NSIS .exe and MSI, macOS 12 as Universal DMG, PKG, and ZIP, and Ubuntu 22.04 or equivalent x64 as AppImage, deb, rpm, snap, and tar.gz; the NSIS installer accepts /S /allusers /disableAutoUpdates for unattended deployment.

Who uses it and how

  • IT teams deploying the client to many machines at once use the NSIS or MSI installer on Windows, the PKG installer on macOS, or the deb package on Linux to install without user prompts.
  • Administrators bundle servers.json with the installer so that new users land on the login screen of a company workspace instead of being asked to connect to a server.
  • Organisations that need predictable client behaviour ship overridden-settings.json to disable auto-update, hide the tray icon, or remove quick reply from notifications.
  • Individual users who belong to several Rocket.Chat workspaces keep the app minimised or in the tray and switch between servers from the sidebar.
  • Mixed desktop fleets are supported through a Universal macOS build for Intel and Apple Silicon and through arm64 and ia32 Windows installers, while Linux deployments target x64.

Getting started

Download the app from the platform store or take an installer from the latest release listed on the project homepage at rocket.chat/download-apps. To build from source, the repository requires Git, Node.js 22.0.0 or later, and Yarn, and it includes its own Yarn 4 release in .yarn/releases.

How it compares

The provided facts do not name any paid products that this app replaces, nor do they name comparable desktop clients, so it stands alone in this registry as the official Rocket.Chat desktop client. Its position rests on being first-party software for the Rocket.Chat platform and on being MIT-licensed, rather than on any documented comparison with other applications.

When to use it — and when not to

Choose it if your organisation already runs a Rocket.Chat workspace and needs a desktop client that can be installed silently, preconfigured, and locked down by administrators. Do not choose it if you are not a Rocket.Chat user: it is a client, not a server, and it connects to workspaces rather than hosting conversations itself. Two limitations are visible in the facts: Linux builds are offered for x64 only with no arm64 variant, and the README excerpt ends mid-sentence in the development prerequisites, so the Linux build requirements are not fully documented in the material available here.

project readme (upstream, from github) — read inline

Rocket.Chat Desktop App

Latest release Total downloads Dependencies License

The official desktop app for Rocket.Chat on Windows, macOS, and Linux, built with Electron.

The desktop app gives you everything in the Rocket.Chat web client, plus:

  • Multiple workspaces in one window: Add all your Rocket.Chat workspaces to the sidebar and switch between them.
  • Native notifications: Get system notifications with inline quick reply on Windows and macOS.
  • Runs in the background: Keep the app in the system tray or minimized so you never miss a message.
  • Built-in video call window: Open calls in an app window instead of a browser tab.
  • Centrally managed settings: IT teams can preset workspaces, lock settings, and install silently at scale.

Rocket.Chat Desktop App

Contents

Download and install

Get the app from your platform's store:

Get it from Microsoft Store  Download on the Mac App Store  Get it from the Snap Store

You can also download an installer from the latest release.

Platform Minimum version Architectures Formats
Windows 10 x64, ia32, arm64 NSIS (.exe), MSI
macOS 12 (Monterey) Universal (x64 + Apple Silicon) DMG, PKG, ZIP
Linux Ubuntu 22.04 or equivalent x64 AppImage, deb, rpm, snap, tar.gz

For step-by-step instructions, see Install desktop and mobile apps.

Silent installation

To deploy the app across many machines without user prompts, use the NSIS or MSI installer on Windows, the PKG installer on macOS, or the deb package on Linux. For example, on Windows:

rocketchat-<version>-win.exe /S /allusers /disableAutoUpdates

For every installer option, see Silent installation for desktop app.

Configure the app for your organization

Admins can control how the app behaves on every device with two JSON files:

  • servers.json: Presets the workspaces that appear in the sidebar the first time a user opens the app. When you bundle it with the installer, users skip the Connect to server screen and go straight to the login screen.
  • overridden-settings.json: Enforces settings such as disabling auto-update, hiding the tray icon, or turning off quick reply in notifications. Combine "isAddNewServersEnabled": false with servers.json to stop users from adding workspaces. The app reads servers.json only when the sidebar has no workspaces, and it does not remove workspaces that users already have.

For file locations on each operating system and the full list of settings, see Preset workspaces and Override settings.

Develop

Prerequisites

  • Git
  • Node.js 22.0.0 or later
  • Yarn. The repository includes its own Yarn 4 release in .yarn/releases, and any recent Yarn install runs that release.

On Linux, you also need these system packages:

# Ubuntu/Debian
sudo apt install build-essential libxss-dev

# Fedora/RHEL
sudo dnf install libX11-devel libXScrnSaver-devel gcc-c++

Quick start

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

yarn start builds the app and watches for changes.

Project structure

The app is written in TypeScript. The source lives in src, and the build compiles it into app, which then contains the full, runnable application.

The build uses the Rollup bundler and has three entry points:

File Runs in Purpose
src/main.ts Electron main process Orchestrates the whole application.
src/rootWindow.ts Root window Renders the UI of the app's main window.
src/preload.ts Privileged preload layer Connects the app to the webviews that render the Rocket.Chat client.

[!IMPORTANT] Only modules listed in dependencies in package.json are included in the distributable app. Put build and test tools in devDependencies.

Lint and test

yarn lint   # ESLint and TypeScript checks
yarn test   # Unit tests

Tests use Jest with the Jest Electron runner. The name and location of a spec decide which Jest project runs it (testMatch in jest.config.js):

  • Main-process specs live under src//main/, or are named src//main.spec.ts.
  • Renderer specs live in a nested folder such as src///, or are named src//renderer.spec.ts(x).

Jest does not find a spec placed directly in src// with any other name. To check that Jest finds a new spec, run yarn test --listTests --runTestsByPath .

Package the app

yarn build
yarn release

yarn build compiles the current source into app. Run it first, because yarn release packages app as it is, and yarn install deletes app. yarn release then packages the app for the operating system you run it on, for the x64 architecture, and writes the installers to dist. Packaging is handled by electron-builder. See its configuration options to customize the output.

Branches and releases

  • Pull requests target dev, the default branch.
  • master holds only released code. Its tip is always the latest stable release.
  • release/X.Y.x branches carry patch releases for a shipped version and merge into master after each patch.

Releases are tag-driven. Pushing a semver tag triggers CI to build every platform and create a draft GitHub release, which a maintainer reviews and publishes.

Contribute

We welcome contributions. Before you open a pull request:

  1. Read the contribution guidelines and the code of conduct.
  2. For a new feature or a larger change, open an issue first so we can discuss it.
  3. Run yarn lint and yarn test, and make sure both pass.

Found a bug? Open an issue with your app version, operating system, and steps to reproduce it.

Found a security issue? Don't open a public issue. Email security@rocket.chat instead. See SECURITY.md.

Get help

License

Released under the MIT license.

Frequently asked questions

Is Rocket.Chat.Electron free to use?

Rocket.Chat.Electron is open source under the MIT licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does Rocket.Chat.Electron do?

Official Rocket.Chat desktop app for Windows, macOS, and Linux. Connect to multiple workspaces, get native notifications, and deploy at scale with silent instal

What is Rocket.Chat.Electron written in?

Rocket.Chat.Electron is primarily written in TypeScript. Its source is publicly available at https://github.com/RocketChat/Rocket.Chat.Electron, and it has 1,707 GitHub stars.