Contributing
Getting Support
Installation
User guides
Administrator guides
- Authentication
  - CAS
  - Ldap
  - Oauth
  - SAML
  - WordPress
- Database-Migration
- Email
- File Upload
  - Amazon S3
  - Minio
- Hubot
- Import
  - CSV
  - HipChat
    - Cloud
    - Enterprise
  - Slack
    - SlackBridge
- Integrations
  - Zapier
  - Azure Alerts
  - BitBucket
  - Giphy
  - GitHub
  - GitLab`
  - Google-Calendar
  - Guggy
  - Jenkins
  - Jira
  - NewRelic
  - nixstats
  - Osticket
  - PagerDuty
  - Prometheus
  - ReplyGif
  - ReviewBoard
  - RunDeck
  - Sentry
  - Telegram
  - Travis CI
  - Trello
  - uptimerobot
- Internal Hubot
- Jitsi Video Bridge
- Livechat
  - Livechat Queues
- Notifications
  - Push Notifications
- Permissions
- Plug-ins
  - Drupal
  - Pidgin
- Create the First Admin
Developer guides
- Quick Start
- Branches and Releases
- Code Styleguide
  - less
- Iframe Integration
- Internationalization
- Livechat API
- Mobile Apps
- Realtime-API
- Rest API
  - Authentication
    - login
    - logout
    - me
  - Channels
    - addAll
    - addModerator
    - addOwner
    - archive
    - cleanHistory
    - close
    - create
    - getIntegrations
    - history
    - info
    - invite
    - kick
    - leave
    - list.joined
    - list
    - open
    - removeModerator
    - removeOwner
    - rename
    - setDescription
    - setJoinCode
    - setPurpose
    - setReadOnly
    - SetTopic
    - setType
    - unarchive
  - Chat
    - delete
    - getMessage
    - pinMessage
    - postMessage
    - react
    - starMessage
    - unPinMessage
    - unStarMessage
    - update
  - Groups
    - addAll
    - addModerator
    - addOwner
    - archive
    - close
    - create
    - getIntegrations
    - history
    - info
    - invite
    - kick
    - leave
    - list
    - open
    - removeModerator
    - removeOwner
    - rename
    - setDescription
    - setPurpose
    - setReadOnly
    - SetTopic
    - setType
    - unarchive
  - Im
    - close
    - history
    - list.everyone
    - list
    - messages.others
    - open
    - setTopic
  - Integration
    - create
    - list
    - remove
  - Livechat
  - Miscellaneous
    - info
  - Settings
    - get
    - update
  - Users
    - create
    - createToken
    - delete
    - getAvatar
    - getPresence
    - info
    - list
    - register
    - resetAvatar
    - setAvatar
    - update
  - Offset and Count and Sort Info
  - Query and Fields Info
- Schema Definition
- Testing
- Troubleshooting
- UI and Theming
  - Colors
  - Components
  - Themes
Community cookbook

Quick start for code developers

Installing Rocket.Chat for Developing

On Windows

To install on Windows please follow this guide.

On Linux/Mac

To run Rocket.Chat for development on a Linux or a Mac you must first have the following programs installed:

Git
Meteor

Once the above two pre-requisites are installed opened the terminal and run the following:

git clone https://github.com/RocketChat/Rocket.Chat.git (if you wish to clone your own fork, replace “/RocketChat/” with /YOUR REPOSITORY NAME HERE/)
cd Rocket.Chat (or the name of your repository)
meteor npm start (Warning: It may take a while to build so please be patient)

When the server is ready, you will see a green box within the terminal with “Server Running” at the top.

This means that a Rocket.Chat server is running from your computer. To access the server navigate to localhost:3000

Editing Rocket.Chat Files

Editing files is relatively simple. After you run git clone, the files from the repository are saved on your computer. You can go to the cloned repository folder and edit or add files to Rocket.Chat. When you make changes to Rocket.Chat the server will automatically rebuild.

Sometimes changes can shut down the server, if that happens just run meteor npm start again.

See Also