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

Bug Reporting

Is it a bug?

GitHub Issues are for bugs and feature requests only.

Examples of things that aren’t considered bugs or feature requests:

Can’t figure out how to do something
Having issues accessing your server
Can’t get the server installed

If your issue falls into one of these categories, please see Getting Support

It is a bug!

Before reporting a new issue

Search the Issues for your bug. If you find it, give it a thumbsup and add some additional information to the ticket if differing. This will help give us a fuller picture.
Make sure you are running the latest version of Rocket.Chat. Its very likely simply updating will resolve your issue.
Try to narrow it down to reproducible steps. If we can reproduce it, we will be able to fix the issue a lot quicker.
Look at logs for errors. See below for how to gather logs.
If you got this far then: Open an issue

Report a new issue

Go here to open a new issue.

Please include the following information in order to promote effective fixing.

Operating System / Version / Architecture (64 bit?)
Browser type and version, including any add-ons. (e.g. AdBlocker, NoScript, etc.)
Rocket.Chat version
Expected behavior
Actual behavior
Can the bug consistently be reproduced? If so, how?
Relevant errors and other log output
Screen shots as necessary

Determining Rocket.Chat Version

Can be done in two ways:

Administration -> Info
Your Rocket.Chat URL followed by /api/info

Gathering Logs

Browser

To collect logs from your browser press Ctrl/Cmd + Shift + j. Errors appear in red.

Server

To collect logs from your browser as an Admin log into your Rocket.Chat. From there click the arrow by your avatar and goto Administration. Once there you will see: View Logs.

Often its useful to open this in another browser and reproduce the problem again and you will see an exception pop up in the logs.