rocketchat / developer-docs

These developer guides and APIs help you start developing on Rocket.Chat quickly.

description
A resource created to assist developers in building upon the Rocket.Chat platform.

Rocket.Chat Developer

Rocket.Chat is more than just a communication platform. It's a versatile workspace that you can tailor to your needs with unique integrations, powerful apps, and webhooks. You can even integrate your custom apps using Rocket.Chat's webhooks to funnel data from external services.

Here's what you can do:

Build and Integrate: Enhance your Rocket.Chat experience with Apps, Webhooks, Live chat, and Rest APIs. As a developer, you have the power to create your own desktop and mobile Rocket.Chat apps. Rocket.Chat apps engine provides a framework that enables users to create and host Rocket.Chat custom apps, integrate workflows with popular apps like Github and Jira, and minimize data loss. You can even build your own Omnichannel apps.

Extend and Customize: Take control of your workspace. Use Bots and the Rocket.Chat API to extend Rocket.Chat's capabilities and tailor the platform to your specific needs.

Contribute: Your expertise matters. Regardless of your technical background, you can contribute to Rocket.Chat. Create issues, write documentation, or make changes in line with our contribution guidelines.

Connect: Join our open server, community, and repositories for more collaborations. Get assistance from our global community and open channels.

To learn more about Rocket.Chat, please visit our user guide. Welcome aboard, and let's build better communication together!

developer-docs's Issues

Login with Meteor Accounts of another Meteor custom app

From issue RocketChat/Rocket.Chat#1422

Link broken in iframe integration docs

On https://rocket.chat/docs/developer-guides/iframe-integration/, the using Using embedded layout mode is not properly working.

How to deploy customized version of RC?

As described in this we are missing docs for creating a custom docker image. I done some changes on my RC and every time I deploy it with pm2-meteor with single instance mongo but I want use docker and replicaset. I can't find any docs about how to deploy customized version of RC. It's all about snap install or completely manual install. Can you help me about it?

Clicking the copy command button on Rocket Chat documentation results in copying of the pwd part as well

Description:

Clicking the copy command button on Rocket Chat documentation results in copying of the pwd part as well. This defeats the purpose of having that button there in the first place.

Steps to reproduce:

1. Go to https://developer.rocket.chat/getting-started/choosing-a-development-host/gitpod
2. Click on any of the copy command buttons
3. Paste the command anywhere

Expected behavior:

Clicking the button should result in copying of only the command and not the directory information

Actual behavior:

Directory gets copied as well

Add missing documentation for getUsersOfRoom

Similar to #46 - the documentation for getUsersOfRoom is missing from the RealtimeAPI section.

"msg": "method", "method": "getUsersOfRoom", "id": callID, "params": [roomID, false]

Passing true will only bring back online users, false will bring back everyone joined in that channel.

[WIP] REST API endpoints Testing Plan

To-Do List:

Note: REST API endpoints with ✓ status means they work well right now that we don't need to update it yet.

• Miscellaneous Information

REST APIs	Related PR	Status
/api/info	#1212	Closed (this endpoint will be deprecated in the future #1146)
/api/v1/directory	#1226	Merged
/api/v1/shield.svg	✓	✓
/api/v1/spotlight	✓	✓
/api/v1/statistics	#1215	Merged
/api/v1/statistics.list	#1215	Merged

• Assets

REST APIs	Related PR	Status
/api/v1/assets.setAsset	#1227	Merged
/api/v1/assets.unsetAsset	#1227	Merged

• Authentication

REST APIs	Related PR	Status
/api/v1/login	#1245	Merged
/api/v1/logout	#1245	Merged
/api/v1/me	#1245	Merged

• Users

REST APIs	Related PR	Status
/api/v1/users.create	#1246	Merged
/api/v1/users.createToken	#1249	Merged
/api/v1/users.delete	#1249	Merged
/api/v1/users.deleteOwnAccount	#1249	Merged
/api/v1/users.forgotPassword	#1249	Merged
/api/v1/users.generatePersonalAccessToken	#1258	Merged
/api/v1/users.getAvatar	#1278	Merged
/api/v1/users.getPersonalAccessTokens	#1258	Merged
/api/v1/users.getPreferences	#1278	Merged
/api/v1/users.getPresence	#1278	Merged
/api/v1/users.getUsernameSuggestion	✓	✓
/api/v1/users.info	✓	✓
/api/v1/users.list	#1280	Pending
/api/v1/users.regeneratePersonalAccessToken	#1258	Merged
/api/v1/users.register	#1280	Pending
/api/v1/users.removePersonalAccessToken	#1258	Pending
/api/v1/users.resetAvatar	#1280	Pending
/api/v1/users.setAvatar	#1280	Pending
/api/v1/users.setPreferences	-	Working in Progress
/api/v1/users.setActiveStatus	-	Working in Progress
/api/v1/users.update	-	Working in Progress
/api/v1/users.updateOwnBasicInfo	-	Working in Progress

• Channels

REST APIs	Related PR	Status
/api/v1/channels.addAll
/api/v1/channels.addLeader
/api/v1/channels.archive
/api/v1/channels.cleanHistory
/api/v1/channels.close
/api/v1/channels.counters
/api/v1/channels.create
/api/v1/channels.delete
/api/v1/channels.files
/api/v1/channels.getAllUserMentionsByChannel
/api/v1/channels.getIntegrations
/api/v1/channels.history
/api/v1/channels.info
/api/v1/channels.invite
/api/v1/channels.join
/api/v1/channels.kick
/api/v1/channels.leave
/api/v1/channels.list
/api/v1/channels.list.joined
/api/v1/channels.members
/api/v1/channels.messages
/api/v1/channels.moderators
/api/v1/channels.online
/api/v1/channels.open
/api/v1/channels.removeleader
/api/v1/channels.rename
/api/v1/channels.roles
/api/v1/channels.setCustomFields
/api/v1/channels.setAnnouncement
/api/v1/channels.setDefault
/api/v1/channels.setDescription
/api/v1/channels.setJoinCode
/api/v1/channels.setPurpose
/api/v1/channels.setReadOnly
/api/v1/channels.setTopic
/api/v1/channels.setType
/api/v1/channels.unarchive

Continuous testing will be done until ensuring all the existing rest API endpoints works well :)

Update Hubot with Docker instructions

I copied the developer docs content for using Hubot with Docker from the old docs. I'm not familiar with running it in Docker but the instructions look wrong to me. Need someone to test it out who has a good setup and write some tips for other Docker loving people.

See current docs here

Instructions for Linux Env does not work

Ive tried the instructions for setting up a Dev Env on Linux (Ubuntu 18.04 LTS) and they dont work.
I think those were created with Rocket 3.4.0 , long time ago.
Do we have more up-to-date instructions?

Can't install dependencies by npm

meteor npm install isn't working.

npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree

In the package.json of meteor,

Rocket.Chat
├─apps
|  ├─meteor
|  |   └package.json

of the line of 204, there is

"@rocket.chat/rest-typings": "workspace:^",

workspace seems to be a feature of yarn.

[Workspaces | Yarn - Package Manager (yarnpkg.com)](https://yarnpkg.com/features/workspaces#workspace-ranges-workspace)

Using yarn may be a better way to install all the dependencies.

meteor npm install yarn
meteor yarn

Also, when running meteor npm start

npm ERR! missing script: start

This is because no start script in the package.json of Rocket.Chat.

meteor npm run build
meteor npm run dev

For step 6, if we want to building this project, commands above may help.

Iframe documentation

Commonly requested feature, and we have it. But I have no idea how it works

ref:

RocketChat/Rocket.Chat#4746
RocketChat/Rocket.Chat#4741
RocketChat/Rocket.Chat#4687
RocketChat/Rocket.Chat#4373
RocketChat/Rocket.Chat#2467

Add docs about message type property.

As per @ktt9117 in the iOS project issues:

Your Rocket.Chat version: 0.48.2 (Latest release version at this time)

My Rocket.Chat server gives the following these message:
I cannot understood "t" attribute meaning likes "uj", "r", "au" etc...
However, where can I find the Messages specification?
I already checked document (https://rocket.chat/docs/developer-guides/realtime-api/the-message-object) but there is no answers. Please let me know thanks

[WebSocket] did receive JSON message:

    "id": "NQnEti5CiBCdjQKcs5x6Thp0yoKE9TcZdpq6tWhNNLYRSMSsYy",
    "result": {
        "unreadNotLoaded": 0,
        "messages": [
            {
                "_id": "WT4XjGRtApAsyL2uB",
                "t": "uj", <--This
                "_updatedAt": {
                    "$date": 1482825773896
                },
                "ts": {
                    "$date": 1482825773896
                },
                "rid": "GENERAL",
                "u": {
                    "_id": "bpz8hgJq5SS3p9yPa",
                    "username": "cjswntjd"
                },
                "msg": "cjswntjd",
                "groupable": false
            },
            {
                "rid": "GENERAL",
                "ts": {
                    "$date": 1482797322172
                },
                "_id": "DaGqKAPx2AonDp2tG",
                "msg": ":man_dancing:",
                "u": {
                    "_id": "mwW3Z9QE8mrRcJCDG",
                    "username": "장동건"
                },
                "_updatedAt": {
                    "$date": 1482797322178
                }
            },
            {
                "rid": "GENERAL",
                "ts": {
                    "$date": 1482796722528
                },
                "_id": "95JJHQ5r2PYgoK7hQY",
                "msg": "에이요맨",
                "u": {
                    "_id": "ZsAA3e53nHeCWu8vo",
                    "username": "gradle"
                },
                "_updatedAt": {
                    "$date": 1482796722536
                }
            },
            {
                "rid": "GENERAL",
                "ts": {
                    "$date": 1482737327475
                },
                "_id": "dCQjrN9yn7ROOI6Kvs",
                "msg": "",
                "u": {
                    "_id": "ZsAA3e53nHeCWu8vo",
                    "username": "gradle"
                },
                "_updatedAt": {
                    "$date": 1482737327479
                }
            },
            {
                "_id": "WvPYcLEG5fb7JzHNY",
                "t": "r", <--This
                "_updatedAt": {
                    "$date": 1482731721025
                },
                "ts": {
                    "$date": 1482731721025
                },
                "rid": "GENERAL",
                "_id": "TZZePZf8BW7Lt8oMW",
                "username": "김성중_LDCC-e-서비스팀-모바일담당"
            },
            "msg": "공지사항",
            "groupable": false
        },
        ......
    }```

*Feature Request * - REST API - Return User "Last Login/active"

It would be nice to get a timestamp from the API where I can see the last activity status of a user.

Can you implement this?

I clicked through all endpoints in the doc or did I miss something and this information is already provided?

Use OpenAPi specification for API documentation.

This will allow generating clients in different languages, more strictly following the documentation, etc.

Message Types and Schemas

@Sing-Li, this is the topic starter for Rocket.Chat team and bot contributors (like @ear-dev) to define how we should improve documentation of the currently opaque details of message attributes within Rocket.Chat.

It's quite important for bot and adapter developers to have a simple reference point, which currently doesn't exist. I'd like to see a the following addressed:

• Document all special message types, uj, ul, au etc
• Keep message and attachment schemas in-sync with code
• Describe the message stream architecture
• Visual reference for attachment attributes

On that last point, in an attachment, there are three strings: message_link, title_link, title_link_download - what is the difference? Or they all even implemented, or are they just clones of the Slack schema and some attributes are actually ignored?

There's parallel work going on in Rocket.Chat apps to define Typescript interfaces. If we could find a way to keep those as the source of truth and generate docs from them on build, that would be an ideal low-resource solution for keeping docs current.

On the stream architecture, it would be good to just detail at least the flow of the subscriptions consumed by the SDK and the meta attributes they contain, like the room type.

Related #42 RocketChat/docs#734 RocketChat/docs#360

Devloping on macOS

We must add the guide about setting up the developer env. on the macOS machine. The docs now only deals with the developing on the linux and windows machine.

Add missing unreadMessages documentation

Add missing documentation for realtime API unreadMessages endpoint.

update documentation for uploading file using ufsCreate

Please update the documentation for sendMessage method for file upload.
since slingshot has been deprecated please update how to call httprequest for the URL which we get after ufsCreate method outside meteor project.

Link broken on Choosing a Deployment Host page

The first link on Choosing a Deployment Host is broken.

Page: https://developer.rocket.chat/quick-start/choosing-a-development-host

Broken link: https://docs.rocket.chat/quick-start/installing-and-updating/official-recommendations

API channel create docs should describe channel naming restraints

I'm working on integrating Rocket.Chat with my application, and I want to create channel names that match the user-facing names of the entities in the app. (It's a sort of course management system for Wikipedia classroom assignments, and I want to set up a channel for each course, using the name of that course.)

Some of the names I want to use are not valid channel names, but I can't find details about which characters are and are not allowed as channel names.

Edit on Github button missing from developer docs

In the old docs there's a link to edit a page on github, it was a handy way to find this repo from the documents and to suggest changes to the docs. This seems to have gone missing in the migration.

Before:

After:

Theming, error on documentation ?

Hi,
Reading: https://github.com/RocketChat/docs/blob/master/guides/developer/ui-and-theming/themes.md

I tried to put the lines in a newly created meteor package.

On activating my meteor package, it says that rocketchat:lib and rocketchat:theme are unknown packages. Also, addFiles yields an error, saying that I need to use addAssets instead.

At this time, a simple change of style is not seen in my 3.6.1 version.

Here is my package.js file:

Package.describe({
	name: 'my-theme',
	version: '0.0.1',
	summary: 'MyTheme',
});
Package.onUse(function(api) {
	api.versionsFrom('1.2');
	api.use([
		'templating',
		// 'rocketchat:lib',
		// 'rocketchat:theme',
	]);
	api.use('templating', 'client');

	api.addAssets([
		'assets/theme.less',
	], 'server');
	api.addAssets([
		'server.coffee',
	], 'server');
});

I do meteor add my-theme to activate it, the above package doesn't give errors (but my theme seems to not change anything in RocketChat, I added a simple body {color: red !important;})

is there anything that is not valid for 3.6.1 version ?

Missing "install" keyword in command to install required tools

Under the "Developing in Windows 10" section of the Developer Guides, the command to install required tools is incomplete and does not work due to the missing "install" keyword.
It should be "sudo apt-get install build-essential git curl python-minimal" instead of "sudo apt-get build-essential git curl python-minimal"

Create TAGs for NOTES and WARNINGS

Please see https://gluu.org/docs/ce/3.1.2/installation-guide/#linode-vm for a good example.

They use MkDocs to convert this

!!! note If you plan on installing more than the default components (i.e. oxAuth, oxTrust, and LDAP), we recommend that your server or VM have at least 8GB of RAM.

!!! warning Docker deployments are not currently supported!

into this

We should do something similar but using https://semantic-ui.com/collections/message.html

Missing details related to HelloWorldApp.ts file:

In Rocket.chat Devs website -> Creating Your First App -> Registering Slash Command, it should be mentioned in the paragraph that the code provided is for the HelloWorldApp.ts file.
Please have a look:

Documentation - env variables

Is there a place where all env variables are available to configure Rocket.Chat?

If not, this would be a nice to have.

Add missing documentation for addUsersToRooms

Add the missing documentation for the addUsersToRooms to the RealtimeAPI section.

I'm guessing by looking at the Rocketchat Websocket request, you just pass through the RoomID and an array of users?

"msg": "method", "method": "addUsersToRoom", "id": callID, "params": [{ "rid": roomID, "users": users }]

Message object schema incomplete

The message object schema doesn't document a couple attributes used by integrations: .bot containing { i: ID_OF_INTEGRATION } and .emoji

I'd submit a PR directly but I'm not sure if those properties are consistently used. I've seen the bot property also used as a boolean instead of an object.

Getting issue /api/v1/users.getAvatar?userId=XXXXXXXXXX

Hi there,

I try to call REST API users.getAvatar.

If a user doesn't set any Avtar then from rocket chat server I got SVG tag so I can directly print on my HTML page.

But the issue is if a user set any image(.png, jpg,etc.) as an Avtar then I can't able to get any perfect image tag or data. So the result is I can't able to print image on my HTML page. Se the following output.

I am using C# language, Can anyone help me to convert this image data, so I can print on my HTML page.

Auto deploy Herkou

Hint at 1-click-deploy:
Node#before is deprecated. Use Node#raws.before
Node#moveTo was deprecated. Use Container#append.

docker-compose -- ERROR: for rocket_mongo_1 dictionary update sequence element #0 has length 20; 2 is required

This happens every time I try to deploy with docker-compose.

# docker-compose --version docker-compose version 1.17.0, build unknown
# docker --version Docker version 17.09.1-ce, build f4ffd2511ce9

Opensuse Leap 15

# docker-compose up -d mongo
Creating network "rocket_default" with the default driver
Creating rocket_mongo_1 ... 

ERROR: for rocket_mongo_1  dictionary update sequence element #0 has length 20; 2 is required

ERROR: for mongo  dictionary update sequence element #0 has length 20; 2 is required
Traceback (most recent call last):
  File "/usr/bin/docker-compose", line 11, in <module>
    load_entry_point('docker-compose==1.17.0', 'console_scripts', 'docker-compose')()
  File "/usr/lib/python2.7/site-packages/compose/cli/main.py", line 68, in main
    command()
  File "/usr/lib/python2.7/site-packages/compose/cli/main.py", line 121, in perform_command
    handler(command, command_options)
  File "/usr/lib/python2.7/site-packages/compose/cli/main.py", line 952, in up
    start=not no_start
  File "/usr/lib/python2.7/site-packages/compose/project.py", line 455, in up
    get_deps,
  File "/usr/lib/python2.7/site-packages/compose/parallel.py", line 70, in parallel_execute
    raise error_to_reraise
ValueError: dictionary update sequence element #0 has length 20; 2 is required

Invite users to private groups

The documentation says:

Private groups are joined through invitation only. The administrator sets the permissions that determine who can invite others to a private group. By default, only administrators, room owners, and moderators can invite others to private rooms.

But, if you are an administrator and want to add a user to a private group, of which you are not a member, then you will fail. API will return you an error:

{
  "success": false,
  "error": "Not allowed [error-not-allowed]",
  "errorType": "error-not-allowed",
  "details": {
    "method": "addUsersToRoom"
  }
}

Please update the documentation for method groups.invite

Readme File is broken

Readme file is broken. All the details, headings, links are not working.

users.list & and "fields" example

In https://developer.rocket.chat/api/rest-api/query-and-fields-info#fields-example , it's explained:

To only return the usernames for users, you would do something like this:
http://localhost:3000/api/v1/users.list?fields={ "username": 1 }

However, as discussed with @rodrigok, this example won't only return usernames, it would return the username field among other default fields, i.e. those listed at https://github.com/RocketChat/Rocket.Chat/blob/develop/app/api/server/lib/users.js#L53

Maybe the documentation is just out of date because this comment (back in 2017) looks to match with what explained in the current documentation.

So for me it boils down to the following questions:

• Do we still want to illustrate the same example, i.e "how to only return specific fields ? (my opinion is it's an useful use case).
• If we do, how do we do that ?
• Do we rather want to remove this use case, and explain how the default fields are coming into place (the specified fields in the request are merged with the defaults ones)

In addition, at https://developer.rocket.chat/api/rest-api/methods/users/list - where a ref to the Query and Fields Query Parameter page above is inserted - it is mentioned :

Gets all of the users in the system and their information (...)

all could let us think that what's returned by default (without fields parameter) are all the fields the callee has access to, while it's rather all fields the callee has access to among the default fields.

Also I would repeat there that including a specific field with 1 doesn't filter out the default fields from the answer, but rather merge it with some default fields.

Once we're clear with the points above, I'd be glad to propose a Pull Request.

Invite endpoints missing instructions to invite users in bulk to a room

Rest Endpoints like channel.invite - Docs link - is missing a param userIds which is an array of userIds. This enables adding users in bulk to a room.
Following are the valid payloads for this endpoint:

{ "roomId": "ByehQjC44FwMeiLbX", "userId": "nSYqWzZ4GsKTX4dyK" }
{ "roomId": "ByehQjC44FwMeiLbX", "userIds": ["nSYqWzZ4GsKTX4dyK", "SYqWzZ4Gsasdfgh"] }

As you can see, either userIds or userId param is required

PS: similar change is required for groups.invite endpoint docs - docs link

Documentation for field 'type' in uikit-building-blocks.md appears to be incorrect

Hey guys! First time contributing here so just wanted to start with something small. I think the type description has an incorrect example in it for the context block in the UIKit documentation.

This line
https://github.com/RocketChat/developer-docs/blame/master/apps-development/uikit/uikit-building-blocks.md#L325

should read

| type | String | Yes | The type of the block, that is this case is 'context' |

as indicated by the code example below that documentation:

{
  type: 'context',
  blockId: 'context_1',
  elements: [ /* block elements */ ]
}

REST API - IM list full name

Is it possible to send users full name on /im.list endpoint?

Error Response while Handelling Interaction Button in parameter of openModalViewResponse().

Description:

While learning about UI Kit, I registered a button following the steps which ended up perfectly. For "handling the interaction", I followed the code which was given on the dev's website. I tried multiple times but it always comes up with this error in the parameter of openModalViewResponse():

Steps to Reproduce:

1. Go to Rocket.chat Devs -> Apps Engine -> Adding Features -> UI Kit -> Action Buttons
2. Under Handling the Interaction, the code is provided. If the code is used in a local machine, it shows a problem in "Blocks".

Link To the page Source:

https://developer.rocket.chat/apps-engine/fundamentals-of-apps/uikit/action-buttons

Please suggest a solution to this problem.

Broken link in the developer docs

The configuration accessor link doesn't redirect you anywhere and says that the page could not be found.
The screenshot is attached below:

Example with "blocks" in chat.sendMessage API

Existing Docs

Expected Behavior

In docs https://developer.rocket.chat/reference/api/rest-api/endpoints/core-endpoints/chat-endpoints/sendmessage possibility to use UIKit "blocks" in message body is not described, but it works. There is even no mention about "blocks". Could you please add this example to the API description?

Extras

And as it works, I have a question - how can I send DM by chat.sendMessage API with blocks section?
I know I can use chat.postMessage but "blocks" doesn't work there, so I wonder if I'm able to use chat.sendMessage or is it possible to send "blocks" through chat.postMessage.

Add missing readMessages endpoint

Add missing documentation for readMessages method

Code typo in README.md

Prerequisites

Please answer the following questions before opening an issue.

• I checked to make sure that this issue has not already been filed
• This issue concerns the developer's docs

Existing Docs

Current Behavior

The Contribute section seems to have a code typo

{% content-ref url="rocket.chat/contribute-to-rocket.chat/" %} [contribute-to-rocket.chat](https://github.com/RocketChat/developer-docs/blob/master/rocket.chat/contribute-to-rocket.chat) {% endcontent-ref %}

What is the intended line here?
So I can fix this issue
Thank you

Image

Authentication for MongoDB

See

RocketChat/Rocket.Chat#2584

wording error in link https://rocket.chat/docs/developer-guides/ui-and-theming/themes/

Description:

in https://rocket.chat/docs/developer-guides/ui-and-theming/themes/, there is no rocketchat-theme in the code repo but rocketchat_theme which will confuse contributor

Steps to reproduce:

1. open https://rocket.chat/docs/developer-guides/ui-and-theming/themes
2. rocketchat-theme should be "rocketchat_theme"

Expected behavior:

rocketchat-theme should be "rocketchat_theme"

Actual behavior:

Server Setup Information:

More opinionated getting started guide

https://rocket.chat/docs/developer-guides/quick-start/

We should be more opinionated. Right now they read more as a few notes. Not enough to really help anyone get started.

We should maybe recommend using vscode(since much of the team uses this). We should also recommend some extensions they should include. Like eslint, git and others that might actually decrease the amount of things we would ask them to change after they get the PR opened.

RocketChat/Rocket.Chat#10586 | https://open.rocket.chat/channel/dev?msg=XWkxas5hJzaZqGgzd

Also we have this great deal included to let them debug with vscode 🔝 we should tell them how to use it.

Add missing documentation for socket-based "saveUserPreferences" method

Hubot has been inactive for two years, and is still in the doc

Prerequisites

Please answer the following questions before opening an issue.

• I checked to make sure that this issue has not already been filed
• This issue concerns the developer's docs

This template can be used to report

• Existing Docs issues

• New Docs request

Clear out any irrelevant section

Existing Docs

The documentation for bot development doesn't seem up to date. Hubot's repository has been inactive for two years, and is still the first link in the list on the Creating your own bot page.

Event "startup" missing in documentation

The startup event implemented in PR6399 is not documented in https://rocket.chat/docs/developer-guides/iframe-integration/events/

Linux Quick start Error "python-minimal has no installation candidate"

When Ubuntu user try to follow the development environment setup given on https://developer.rocket.chat/guides/developer/quick-start. The first Command sudo apt install g++ build-essential git curl python-minimal there comes an error "python-minimal has no installation candidate" this is no one command run easy error so we should provide a list of error they can encounter including the above one. I myself encountered the error and spent hours resolving it. So can anyone incorporate the solution there on the guide or you can add this on the possible errors page . I've resolved the issue so you just have to add this to the code.
Solution- To error "python-minimal has no installation candidate"

1. First run sudo -i to run commands as root
2. Now make a copy of sources.list file by mv /etc/apt/sources.list /etc/apt/sources.list_stor
3. Then update packages apt-get update
4. Now edit sources.list file
   * Open file by vi /etc/apt/sources.list
   * Press i to change into insert mode
   * Copy paste this inside
   deb http://archive.ubuntu.com/ubuntu​ bionic main restricted universe multiverse
   deb http://archive.ubuntu.com/ubuntu​ bionic-security main restricted universe multiverse
   deb http://archive.ubuntu.com/ubuntu​ bionic-updates main restricted universe multiverse
   deb http://mirror.kakao.com/ubuntu​ focal-security main restricted
   deb http://mirror.kakao.com/ubuntu​ focal-security universe
   deb http://mirror.kakao.com/ubuntu​ focal-security multiverse
   * Press shift+esc and type :x and enter to save sources file
5. Run apt-get update again.
6. Run apt-get install python
7. Then come back to main terminal and run sudo apt install python-minimal.

Improve OAUTH Docs

https://github.com/RocketChat/Rocket.Chat.Docs/blob/master/5.%20Administrator%20Guides/Authentication/OAuth/README.md

Specifically maybe we should give a bit more walk through on some. Some people have issues getting the client id and secret, due to naming and other misc reasons.

stream room messages not working

I followed https://github.com/RocketChat/docs/tree/master/developer-guides/realtime-api/livechat-api. I have registered a guest user and agent is getting a message. But when I subscribe for stream-room-messages, its not working. When I refer subscription docs it says you need to login but in case of guest user we dont have any login procedure. Please help me how can I subscribe guest user messages.