Skip to main content
Version: Canary 🚧

RocketChat server developing

Rocket.Chat1 is an open-source fully customizable communications platform developed in JavaScript for organizations with high standards of data protection.

We are the ultimate Free Open Source Solution for team communications, enabling real-time conversations between colleagues, with other companies or with your customers, regardless of how they connect with you. The result is an increase in productivity and customer satisfaction rates.

Useful links

RocketChat Server

RocketChat Server README

Prerequisites​

You can follow these instructions to setup a dev environment:

info
  • node v14.21.3
  • yarn 3.5.0
  • git branch is develop

Starting RocketChat​

  1. To install all dependency libraries by yarn command.
yarn
  1. It will take long time to build porject with yarn dsv command.
yarn dsv # run only meteor (front and back) with pre-built packages
  1. If server runing info showed in the shell, it means build and run the RocketChat Server successfully.
@rocket.chat/meteor:dsv: I20240725-08:53:04.194(0)? +-----------------------------------------------+
@rocket.chat/meteor:dsv: I20240725-08:53:04.194(0)? |                 SERVER RUNNING                |
@rocket.chat/meteor:dsv: I20240725-08:53:04.195(0)? +-----------------------------------------------+
@rocket.chat/meteor:dsv: I20240725-08:53:04.195(0)? |                                               |
@rocket.chat/meteor:dsv: I20240725-08:53:04.196(0)? |  Rocket.Chat Version: 6.11.0-develop          |
@rocket.chat/meteor:dsv: I20240725-08:53:04.196(0)? |       NodeJS Version: 14.21.4 - x64           |
@rocket.chat/meteor:dsv: I20240725-08:53:04.196(0)? |      MongoDB Version: 7.0.5                   |
@rocket.chat/meteor:dsv: I20240725-08:53:04.196(0)? |       MongoDB Engine: wiredTiger              |
@rocket.chat/meteor:dsv: I20240725-08:53:04.197(0)? |             Platform: linux                   |
@rocket.chat/meteor:dsv: I20240725-08:53:04.197(0)? |         Process Port: 22674                   |
@rocket.chat/meteor:dsv: I20240725-08:53:04.197(0)? |             Site URL: http://localhost:3000/  |
@rocket.chat/meteor:dsv: I20240725-08:53:04.197(0)? |     ReplicaSet OpLog: Enabled                 |
@rocket.chat/meteor:dsv: I20240725-08:53:04.197(0)? |          Commit Hash: 978e2d18f6              |
@rocket.chat/meteor:dsv: I20240725-08:53:04.198(0)? |        Commit Branch: develop                 |
@rocket.chat/meteor:dsv: I20240725-08:53:04.198(0)? |                                               |
@rocket.chat/meteor:dsv: I20240725-08:53:04.198(0)? +-----------------------------------------------+

warning

The following command always failed.

yarn dev # run all packages

After initialized, you can access the server at http://localhost:3000

More details at: Developer Docs PS: For Windows you MUST use WSL2 and have +12Gb RAM

Logs levels​

Logs are a very useful way to monitor workspace activities in detail. They can also be very helpful for debugging in case of failures or errors. Here, you have the interface to configure how server logs are received.

To access this section, go to Administration > Workspace > Settings > Logs.

  • Log Exceptions to Channel: Set a channel to receive all captured exceptions. Leave empty to ignore exceptions.

  • Log Level: A dropdown to select the level of logs to receive

  • Log View Limit: The limit of logs to view

  • Trace method calls: When enabled, it enables a trace of every method call.

  • Trace method filter: The text here is evaluated as RegExp (new RegExp('text')). Keep it empty to show a trace of every call.

  • Trace subscription calls: If enabled, every subscription call will be traced.

  • Trace subscription filter: The text here is evaluated as RegExp (new RegExp('text')). Keep it empty to show a trace of every call.

  • Log Exceptions to Channel: A channel that receives all captured exceptions. Leave empty to ignore exceptions.

Disable Two-factor authentication (2FA)​

Navigate to Administration > Workspace > Settings> Accounts. You can view a list of some methods that are supported by Rocket.Chat:

  • Two Factor Authentication
  • Allow Name Change
  • Allow Email Change
  • Allow Username Change
  • Allow ... Change