rocketchat/docs

Rocket.Chat's user documentation.

docs's Issues

Incorrect CLI name mongo in manual install document

In deploy/prepare-for-your-deployment/other-deployment-methods/manual-installation/debian-based-distros/ubuntu , there is an instruction to run
mongo --eval "printjson(rs.initiate())"
The command name is mongosh, not mongo.

I think it is also similarly wrong for Debian and Kali, but I'm not sure.

4.8.7 still supported?

Hi,

is 4.8.7 still supported? It is not listed in

https://docs.rocket.chat/resources/get-support/enterprise-support#rocket.chat-versions

but is - as far as I got it right - currently the last version of the 4.8 branch. Am I right that if it was the forever last version of the 4.8 branch it has to be supported 6 months from release date, that is May 24th.

Regards
abelbabel

AWS deployment CERTBOT cert only

https://docs.rocket.chat/deploy/prepare-for-your-deployment/cloud-deployments/aws

in this tutorial, we are only getting a certificate from CERTBOT, not the entire setup. In my personal experience, we could setup nginx first, then use certbot to get a certificate and configure it and then restart nginx. This makes sure that there is less things for the user to configure (and less errors).

I would be curious to know why isn't this the case, maybe I don't know something.

Download link for manual install is broken

Hi,
The Links in the guides for manually installing rocket.chat return a 404 instead of the latest build:
https://docs.rocket.chat/deploy/prepare-for-your-deployment/other-deployment-methods/manual-installation/debian-based-distros/debian

As a workaround I got the latest build from the CDN to get my install back up and running:
https://cdn-download.rocket.chat/build/rocket.chat-6.1.2.tgz

hint

% hint style="info" %} As of December 15, 2023, Rocket.Chat has ceased support for connections from cloud services and official mobile/desktop apps to workspaces running legacy versions outside our support window. Users on unsupported legacy servers are advised to upgrade to the latest Rocket.Chat version to ensure continued access to cloud, mobile, and desktop applications. Each Rocket.Chat version is supported for six months post-release. {% endhint %}

Broken link for Integration Documentation

Hey folks, Our documentation of Rasa RocketChat connector links to the RocketChat Integrations documentation. It seems like this link is now broken, https://docs.rocket.chat/guides/administration/admin-panel/integrations

Can you tell us what should I replace this documentation link with?

Reopen PR here?

Ex RocketChat/docs-old#2104

cc @dudanogueira @pierre-lehnen-rc @rodrigok

Rest API update-user documentation.

Please point out that roles in /api/v1/users.update needs to be the ID of the role not the name. Wellknown roles in rocketchat has the same id as Name. But custom roles has not.

https://developer.rocket.chat/reference/api/rest-api/endpoints/user-management/users-endpoints/update-user

Custom OAuth - documentation/help text improvements

Description:

The Custom OAuth menu is currently without any help text, and rocket.chat docs doesn't mention how to set one up so part from the Callback URL the menu provide you're pretty much left figuring it out yourself.

Suggested improvements:

• Add help text to fields that needs more explanation. Ie. it isn't very intuitive that the Scope field takes a space-separated list of scopes (maybe rename to 'Scope(s)' would be appropriate), or how the Username field is mapped (from what I can tell you can tell where to look for values named 'username', but not a field called something else)
• Add documentation on Custom OAuth to the Rocket.Chat Docs

Placeholder or syntax used in this documentation system ?

Below the Key references section why the rest of the doc is formatted with this -
{% content-ref url="..." %} and ... ?

The formatting you've provided, such as {% content-ref url="..." %} and ..., appears to be a placeholder or syntax used in a particular documentation system or platform to reference or link to other documents or resources. It's not meant to be presented as part of the final documentation that end-users will read.

In the final documentation, this formatting should be replaced with the actual content or links that it points to. Users should see a clear and direct link or description of the resource they can access, rather than the placeholder or reference code.

Here's how it might look in the final documentation:

Minimum Requirements
Minimum Requirements for Client Apps

Support
Rocket.Chat Support Structure

Developer Guides
Developer Portal

In this way, users can easily access the relevant information without seeing the underlying formatting or placeholders.

Snap deployment: error: cannot find app "initcaddy" in "rocketchat-server"

I'm following this guide: https://github.com/RocketChat/docs/blob/main/deploy/deploy-rocket.chat/deploy-with-snaps.md#auto-ssl-with-snaps

At one point, there is this snippet:

sudo snap set rocketchat-server caddy-url=https://<your-domain-name>
sudo snap set rocketchat-server caddy=enable
sudo snap set rocketchat-server https=enable
sudo snap run rocketchat-server.initcaddy

But sudo snap run rocketchat-server.initcaddy results in the error:
error: cannot find app "initcaddy" in "rocketchat-server"

Is the documentation outdated? I'm running rocketchat-server 6.5.2 via snap.

Team owners/managers

Reading the docs, it doesn't get clear if a team can have a member with permissions to manage that team specifically and not the entire workspace. How does that work?