Setting up Rocket.Chat on Windows requires using the WSL2. Windows Subsystem for Linux 2 (WSL2) is a complete architectural overhaul of Linux on Windows, installing an entire Linux kernel (built by Microsoft) alongside the classic Windows kernel. The Linux and Windows kernels can now share system resources, such as memory and CPU, at a previously impossible granularity.
To set up Rocket.Chat development environment, you'll require a Windows machine that meets the following minimum specifications:
- 12 GB of RAM (16+ GB highly recommended)
- Four or more cores on CPU (at least 3 GHz boosted, 4.2 GHz or higher recommended)
- 80 GB of available fast SSD storage (PCIe 4.0 NVMe SSD recommended)
Before establishing a Rocket.Chat development environment on Windows, consider these key points:
During the build, you may notice peer or transitive dependencies warnings. They are typically safe to ignore unless you are coding the required features or modules.
- Open the Ubuntu WSL 2 shell and update the distro by running this command.
sudo apt-get update && sudo apt-get dist-upgrade -y
curl https://install.meteor.com/ | sh
Alternatively, Install a specific Meteor version using this command replacing
x.xwith the version number:
curl https://install.meteor.com/?release=x.x | sh
npm install --global yarn
git clone https://github.com/<your-username>/Rocket.Chat.git
- Navigate into the directory and install all the dependencies by running these commands:
- When completed, build and run the server by executing this command:
The first build can take ten or more minutes, and you may see various warnings or minor errors. Subsequent dev builds will take lesser time.
- The server will start up on port
3000and you will see the "Server Running" screen
A successful running server will open up port
3000on your machine where you can access Rocket.Chat using any browser or the Rocket.Chat client app through
To edit Rocket.Chat files,
- Open the cloned repository folder on your IDE.
- When you make changes to Rocket.Chat the server will automatically rebuild.
- Sometimes changes can shut down the server. If that happens, run
Last modified 3mo ago