General Settings

To access the general settings of your workspace, navigate to Administration > Workspace > Settings > General.

Configure general workspace settings

Field	Description
Show Setup Wizard	Do not alter this setting. It is set automatically from `Pending` -> `In Progress` -> `Completed` depending on whether your workspace's general setup procedure has been completed. Changing this manually can lock your workspace. Refer to this issue for details.
Site URL	This is the URL of the workspace. Example: `https://chat.domain.com/`
Site Name	Set the name of the workspace. Example `My Rocket.Chat Server`
Document Domain	Enter the document domain. See the Document:domain property for details.
Language	Select the default language for the workspace. This setting is overridden if the user has changed their language preference. Refer to the Account - Localization settings for language preference priority in Rocket.Chat.
Allow Invalid Self-Signed Certs	Enable this option to allow invalid and self-signed SSL certificates for link validation and previews.
Enable Content-Security-Policy	Do not disable this option unless you have a custom build and are having problems due to inline scripts.
Extra CSP Domains	Extra domains to add to the Content-Security-Policy.
Restrict access inside any Iframe	Enable this option to restrict loading Rocket.Chat inside any iframe.
Options to X-Frame-Options	See X-Frame-Options for details.
Enable Favorite Rooms	Enable this option to allow users to mark a room as a favorite. See how to mark rooms as favorite.
First Channel After Login	Enter the channel name the user joins by default after logging in. Setting this field to empty or setting an invalid name results in the user being directed to the workspace's home page. Example: `#general`
Unread Count	Select the behavior of the unread counter: All messages: All unread messages are displayed on the counter, regardless of whether users are mentioned or not. User mentions only: Only mentions using `@yourUsername` are counted on the counter. Group mentions only: Only group mentions using `@all` or `@here` are counted on the counter. User and group mentions only: All mentions are counted; this includes `@all`, `@here` and `@yourUsername`
Unread Count for Direct Messages	Select the behavior of the unread counter for DMs: All messages: All unread messages are counted on the counter. Mentions only: Only mentions using `@yourUsername` are counted on the counter.
Unread Count for Omnichannel Chats	Select the behavior of the unread counter for Omnichannel chats: All messages: All unread messages are counted on the counter. Mentions only: Only mentions using `@yourUsername` are counted on the counter.
DeepLink_Url	Set the deep link URL. See Deep linking for details.
CDN Prefix	If you want to use a CDN to load your workspace assets, enter your CDN prefix here.
Use CDN Prefix for all assets	Enable this option if all assets from the workspace come from a CDN.
CDN Prefix for JS/CSS	Enter the prefix for the CDN that should load the JS/CSS assets here.
Force SSL	You can enable this setting to force SSL on your workspace. We strongly discourage the use of this setting; redirecting to HTTPS should be done at the reverse proxy level. This option exists for deployments like Heroku, that does not allow the redirect configuration at the reverse proxy.
Google Tag Manager ID	You can use Google Tag Manager on Rocket.Chat by entering your ID in this setting.
Bugsnag API Key	If you are integrating Bugsnag with Rocket.Chat, enter your Bugsnag API Key here.
Store Last Message	Enable this option to store the last message sent in each room. This enables the viewing of the last message on the left sidebar when the Sidebar Channel List Mode field in the Accounts setting is selected as `Extended`.
Robots.txt File Contents	Set the content of the `Robots.txt` file, used to help index your workspace on different search engines and crawlers.
Default Referrer Policy	This controls the `referrer` header that's sent when requesting embedded media from other workspaces. For more information, refer to MDN. A full page refresh is required for this to take effect.
Enable second-layer encryption for data transport	Enable second-layer encryption. This feature is currently in alpha.
Restore defaults	Click this button to reset the settings to their default values.

Set apps settings

Modify your workspace’s apps settings from Settings > General > Apps tab.

Field	Description
Number of days to keep logs from apps stored	Set the number of days to store logs from Rocket.Chat Apps.
Apps' Source Package Storage type	Choose where all the apps' source code should be stored. Each app can be multiple megabytes in size. The options are GridFS and FileSystem.
Directory for storing apps source package	If you select the app source storage type as FileSystem, you need to enter the absolute path in the filesystem for storing the apps' source code (in `.zip` file format).

Set REST API settings

Modify your workspace’s REST API settings from Settings > General > REST API tab.

Field	Description
Max Record Amount	Set the maximum number of records the REST API should return when not set to unlimited.
Default Count	Ente the default count for REST API results if the consumer did not provide any.
Allow Getting Everything	This setting affects the `count` query parameter. See more at Offset and Count Information. Enabled: Allows the usage of the number `0` as `count` parameter. Setting `count` to `0` returns ALL the data from that endpoint. Disabled: Setting the number `0` on `count`, returns `0` results.
Enable Direct Message History Endpoint	This enables the `/api/v1/im.history.others` endpoint which allows the viewing of direct messages sent by other users that the caller is not part of.
Enable Shields	Enables the usage of Shields via API. Shields are available at `/api/v1/shield.svg`
Shield Types	Enter the types of shields to enable as a comma-separated list, choose from `online`, `channel` or `*` for all.
Require authentication for users shields	Set if user authentication is required for shields.
Enable CORS	Enable CORS for REST API. Enabling CORS makes the workspace only accept API calls from specific origins. Disabling this option makes your workspace only accept requests from the same domain of the said workspace. For example, the Rocket.Chat workspace will only accept requests from the Rocket.Chat domain.
CORS Origin	Here, you can set what origins are allowed to make requests to your workspace. You can use `*` to accept from all origins. For multiple origins, use a comma-separated list. For example, `https://domain1.com, https://domain2.com, https://domain3.com`
Use REST instead of WebSocket for Meteor calls	Enable this option if REST is used instead of WebSocket for Meteor calls.
User Limit for Adding All Users to Channel	Enter the maximum number of users that can be added to a channel simultaneously.
Restore defaults	Click this button to restore the settings to their default values.

Workspace update settings

Modify your workspace’s update checker settings from Settings > General > Update tab.

Field	Description
Update Latest Available Version	Displays the latest versions available.
Enable the Update Checker	Enable this option if you want to receive new update notifications and important messages from Rocket.Chat developers. The notification appears once per new version as a clickable banner and as a message from the Rocket.Cat bot, both visible only to administrators.

Notifications settings

Modify your workspace’s notifications settings from Settings > General > Notifications tab.

Max Room Members Before Disabling All Message Notifications: Enter the maximum number of members in the room when notifications for all messages are disabled. Users can still change the per-room setting to receive all notifications individually (enter 0 to disable).

Iframe integration settings

Modify your workspace’s iframe settings from Settings > General > Iframe Integration tab.

For details on configuring iframe, see the Iframe Integration section.
To be able to use the microphone, camera, and geolocation in an iframe, be sure to allow the iframe features policy. For example,
<iframe src="https://open.rocket.chat/" allow="geolocation; microphone; camera"></iframe>

Field	Description
Enable Send	Enable this setting to allow Rocket.Chat to send events to the parent window.
Send Target Origin	Origin with protocol prefix, which commands are sent to e.g. `https://localhost`, or `*` to allow sending anywhere.
Enable Receive	Enable this settings to allow a parent window to send commands to Rocket.Chat.
Receive Origins	Origins with protocol prefix, separated by commas, which are allowed to receive commands e.g. `https://localhost`, `http://localhost`, or `*` to allow receiving from anywhere.
Restore defaults	Click this button to restore the settings to their default values.

NPS settings

Net Promoter Score (NPS) survey

Stream Cast settings

If you are using Stream Cast, modify the settings from Settings > General > Stream Cast tab.

Stream Cast Address: Enter the IP or host of your Rocket.Chat central Stream Cast. For example, 192.168.1.1:3000 or localhost:4000

Workspace timezone settings

Modify the workspace’s timezone settings from Settings > General > Timezone tab.

Field	Description
Default timezone for reporting	Select the default timezone that is used when showing dashboards or sending emails. The options are as follows: Server timezone: Use the Rocket.Chat server timezone for all workspace users. Custom timezone: Select a specific time zone for all workspace users. User’s current timezone: Select this option to set it to the user’s timezone.
Custom timezone	If you select the Custom timezone option as the default timezone, you can select the timezone of your choice from the drop-down menu. If you select any other default timezone option, this setting is disabled.

Field

Description

Default timezone for reporting

Select the default timezone that is used when showing dashboards or sending emails. The options are as follows:

Server timezone: Use the Rocket.Chat server timezone for all workspace users.
Custom timezone: Select a specific time zone for all workspace users.
User’s current timezone: Select this option to set it to the user’s timezone.

Custom timezone

If you select the Custom timezone option as the default timezone, you can select the timezone of your choice from the drop-down menu. If you select any other default timezone option, this setting is disabled.

Define translations

Configure your workspace’s translation settings from Settings > General > Translations tab.

Custom Translations: With this setting, you can configure custom translations for your workspace. It should be a valid JSON where keys are languages containing a dictionary of keys and translations. For example:

{
 "en": {
  "Channels": "Rooms"
 },
 "pt": {
  "Channels": "Salas"
 }
}

UTF8 settings

Configure the name validation rules of usernames and rooms from Settings > General > UTF8 tab. If you are having problems with names when creating channels (such as, when using non-English characters), changing these values will probably fix it. For example, using [\w_-]+ should allow any non-space character to be part of a name.

Field	Description
UTF8 Usernames Validation	Enter the regular expression that will be used to validate usernames. By default, the value is `[0-9a-zA-Z-_.]+`. Example: To allow Japanese strings, enter the regex `[\u3040-\u309f\u30a0-\u30ffーa-zA-Zａ-ｚＡ-Ｚ0-9\u4e00-\u9fff-０-９-、。_.]+`. This allows you to create usernames containing Japanese characters and the avatars are displayed using the first character.
UTF8 Channel Names Validation	Enter the regular expression that will be used to validate channel names. By default, the value is `[0-9a-zA-Z-_.]+`. Example: To allow Japanese strings, enter the regex `[\u3040-\u309f\u30a0-\u30ffーa-zA-Zａ-ｚＡ-Ｚ0-9\u4e00-\u9fff-０-９-、。_.]+`. This allows you to create channels containing Japanese characters and the channel avatars are displayed using the first character.
UTF8 Names Slugify	Enable this option to create slugs for names.
Restore defaults	Click this button to restore the settings to their default values.