⚠️ This is not a deployment guide. If you want to deploy a workspace for your team or organization, refer to Deploy Rocket.Chat. The recommended deployment methods are Docker and Kubernetes.
The Rocket.Chat server is the core application that powers the web, desktop, and mobile clients. This section guides you through setting up a development environment, working with the source code, and understanding how the server is organized.
Before setting up your environment, familiarize yourself with the codebase:
GitHub repository: Explore the source code.
Repository structure guide: Get an overview of workspace packages, directories, and module entry points.
Server architecture and components: Learn more about Rocket.Chat platform structure and how various component interacts.
Getting started
Choose your path below to set up, build, and customize the server:
Set up your local server environment: Step-by-step installation guides for macOS, Linux, or Windows.
Customize your server: Learn how to add custom UI components, modify default behaviors, and adapt the server to specific organizational needs.