Accounts Settings

You can modify the workspace member account settings by navigating to Administration > Workspace > Settings > Accounts. Most settings can be either enabled or disabled. These settings affect your entire workspace users.

These settings help you customize your workspace according to your requirements, including controlling various user options and security configurations.

Set user account settings

Field

Description

Allow Anonymous Read

If this option is enabled, people can chat without creating an account or logging in. Anonymous users are only allowed to read messages on public channels.

By default, the general channel is visible to anyone who accesses the workspace.

Allow Anonymous Write

If this option is enabled, anonymous users can post messages on public channels. This option is disabled and cannot be updated if the Allow Anonymous Read setting is disabled.

By default, anonymous users can send messages on the general channel.

Allow users to Delete Own Account

If this option is enabled, users can delete their own accounts from their profile settings. When a user is deleted, all their messages are deleted too.

Allow User Profile Change

If this option is disabled, users cannot change their information from their profile settings. Users will need to contact the workspace administrator to do so. Admins can update a user’s information from the Users tab.

Allow User Avatar Change

If this option is disabled, users cannot change their profile avatar. Users will need to contact the workspace administrator to do so. Admins can update a user’s information from the Users tab.

Allow Name Change

If this option is disabled, users cannot change their profile names. Users will need to contact the workspace administrator to do so. Admins can update a user’s information from the Users tab.

Allow Custom Status Message

Enabling this option allows users to create a custom status message.

Allow Username Change

If this option is disabled, users cannot change their usernames. Users will need to contact the workspace administrator to do so. Admins can update a user’s information from the Users tab.

Allow Email Change

If this option is disabled, users cannot change their account email ID. Users will need to contact the workspace administrator to do so. Admins can update a user’s information from the Users tab.

Allow Password Change

If this option is disabled, users cannot change their account password. Users will need to contact the workspace administrator to do so. Admins can update a user’s information from the Users tab.

Allow Password Change for OAuth Users

If you have configured an OAuth method for user identification, you can disable this option if you don’t want users to change their passwords. You can choose to manage the user’s information from the identity provider you are using.

Allow Email Notifications

Enable this option to allow users to receive email notifications. The workspace’s email settings must be configured.

Allow Feature Preview

Enable this option to allow your users access to experimental features. For details, see Feature Preview.

Custom Fields to Show in User Info

Enter additional fields to display in the user information panel. The value must be an array of objects where the key is the label and the value the field name.

For example:

[
  {"Role Label": "role"},
  {"Twitter Label": "twitter"}
]

Refer to Custom Fields for more details.

Login Expiration in Days

Enter the number of days after which a user is logged out if they are inactive.

Placeholder for Email or Username Login Field

You can change the placeholder text for the email or username fields on the login screen.

Placeholder for Password Login Field

You can change the placeholder text for the password field on the login screen.

Confirm Placeholder for Password Login Field

You can change the placeholder text for the confirm password field on the login screen.

Forget user session on window close

Enable this option to log out users when they close the window running Rocket.Chat. They will need to log back in when they access the workspace.

Fields to Consider in Search

Specify the fields to consider when searching for users. The default value is username, name, bio, nickname.

Default Directory Listing

Select the default directory to be displayed when you access the Directory.

Allow Invisible Status Option

Enable this option to allow users to set the invisible status.

Reset defaults

Click the button to return configurations to their default values.

Set default user preferences

To access these settings, go to Administration > Workspace > Settings > Accounts > Default User Preferences tab.

Default user preferences for notifications are universal for all the users in your workspace until a user changes it for themselves.

Field

Description

Enable Auto-Away

When this option is enabled, it automatically changes the user's status to Away when they exit Rocket.Chat. Users can also choose to enable or disable auto-away from their profiles (manage user presence).

Idle Time Limit

Set the time (in milliseconds) a user status takes to becomes idle.

Require Interaction to Dismiss Desktop Notification

If this option is enabled, the notification prompts are active until the user interacts with it.

Desktop Notifications Default Alert

Select when the desktop notification alert is triggered. By default, the value is All messages. This only concerns the groups and channels the user belongs to.

Push Notifications Default Alert

This setting allows users to choose whether to receive push notifications. By default, the value is All messages.

See the Configure Push Notifications document to learn how to configure mobile push notifications.

Unread Tray Icon Alert

Disabling this stops the unread tray icon from displaying.

Use Emojis

Enable this option to use emojis in your workspace.

Convert ASCII to Emoji

Enable this option to automaticall convert ASCII characters to emojis in messages.

Auto Load Images

Disabling this option prevents images from loading automatically when a room is opened. Users will be able to view images only when they click it to load it.

Save Mobile Bandwidth

When enabled, this options helps to save mobile data.

Collapse Embedded Media by Default

Enabling this option causes embedded media cards to collapse in messsages.

Hide Usernames

Enable this option to hide usernames in conversation rooms.

Hide Roles

When this option is enabled, user roles are not displayed in rooms.

Hide Contextual Bar by clicking outside of it

Enabling this option closes the right sidebar once you click outside of it. Otherwise, you need to close it using the close button.

Display Avatars

Enabling this option displays the user's avatars in room messages.

Group by Type

Enabling this option lets you group rooms by type in the left sidebar, such as, DMs, channels, teams, and discussions. If this option is disabled, all rooms are listed together and sorted by the latest conversations.

Theme Appearance

This allows you to set the theme of the workspace (light or dark mode). The default is Match System which matches the user’s device theme.

Sidebar Channel List Mode

This option lets you choose the left sidebar size, Extended, Medium, Condensed. The Extended mode size displays the latest message in the left sidebar. By default, the value is Medium and only the room names are displayed.

Display Avatars in Sidebar

Disabling this option disables avatars from showing in the left sidebar.

Unread on top

Enabling this option displays all unread messages at the top of the left sidebar.

Sort by

This lets you sort the list by user activity or alphabetical order.

Always show thread replies in main channel

When this option is enabled, all replies under a thread will also be displayed directly in the main room. When this option is disabled, thread replies will be displayed based on the sender's choice.

Also send thread message to channel behavior

Select the behavior of messages sent in a thread.

Threads contain a Also send to channel option that displays a thread message in the room also. With this setting, you can select a default behavior for thread replies.

  • Selected for first reply, unselected for following replies: The Also send to channel thread option will be selected for first replies and unselected for all other replies. Users can then select or unselect this option when sending thread replies.

  • Selected by default: The Also send to channel thread option will be selected for all thread replies.

  • Unselected by default: The Also send to channel thread option will be unselected for all thread replies.

Group favorites

Enabling this option groups favorite rooms together at the top of the left sidebar.

Enter key Behavior

Select the result of using the Enter key. The available options are:

  • Normal mode (send with Enter)

  • Alternative mode (send with Enter+Ctrl/Alt/Shift/CMD)

  • Desktop mode (only sends with enter on desktop)

Offline Email Notifications

Select when users should receive email notifications when they are offline.

New Room Notification

Select the notification when a new room is created or joined.

New Message Notification

Select the notification for new messages.

Mute-Focused Conversations

When this option is enabled, no notifications are sent for focused/open conversations.

Master volume

Set the volume for all notifications.

Notifications sound volume

Set the notification volume.

Call ringer volume

Set the call notification volume.

Send chat transcript via email

If this option is enabled for Omnichannel, the transcript is sent to contacts at the end of the conversations.

Notify calendar events

If this option is enabled, users are notified of calendar events.

Enable mobile ringing

Enable this option to allow ringing on mobile for new calls.

Sidebar sections order

As an admin, you can select and change the order of room categories displayed on the left-hand sidebar. The available options are:

  • Incoming calls

  • Queued chats

  • Chats in progress

  • On hold

  • Unread

  • Favorites

  • Teams

  • Discussions

  • Channels

  • Direct messages

  • Conversations

Accounts Default User Preferences Features Preview

Displays all the feature preview settings selected by the user.

Reset defaults

Click the button to return configurations to their default values.

Set user and room avatars

To access these settings, go to Administration > Workspace > Settings > Accounts > Avatar tab.

Field

Description

Resize Avatar

Enable this option to resize user avatars to a predefined size. This feature requires ImageMagick or GraphicsMagick installed on your server.

Avatar Size

The desired size (in pixels) after the avatar resizing.

Avatar External Provider URL

Set a URL from which avatars can be loaded. Example: https://acme.com/api/v1/{username}.

Room Avatar External Provider URL

The URL from where the room avatar is loaded.

Avatar cache time

This sets how long (in milliseconds) user avatars are to be cached.

Block Unauthenticated Access to Avatars

When this option is enabled, this feature restricts unauthenticated users from accessing avatars.

Set Default Avatar

If this setting is enabled, Rocket.Chat tries to find a default avatar based on the user’s OAuth Account or Gravatar.

Configure iframe login page

Iframe authentication in Rocket.Chat enables user authentication via your custom login page in your web application, rather than the Rocket.Chat login page. For iframe authentication configuration details, see the Configuring iFrame auth topic.

If you have configured iframe, you can access the following settings from Administration > Workspace > Settings > Accounts > Iframe tab.

  • The login page can be created in any programming language and/or web framework.

  • Setting API URL and API Method parameters enables Rocket.Chat to call the third-party system to either log in or verify if the user is already logged in.

Field

Description

Enabled

Enable this option to authenticate users using your own login page instead of Rocket.Chat's login page via the iframe integration.

Iframe URL

Enter the URL of the page you want to show as the login page of your Rocket.Chat instance. The login page then communicates back to Rocket.Chat using postMessage API.

API URL

Enter the URL, which refers to the endpoint on the third-party system. This checks if the user is already logged in to that system.

API Method

Specify the API (POST) method Rocket.Chat will use to submit information to the API URL

If the user has already logged into the third-party system, the API URL should communicate to Rocket.Chat and return a JSON object containing either a token or loginToken property, otherwise (if the user is not already logged in) the API URL should return an empty body with the status 401.

Failed login attempt settings

To access these settings, go to Administration > Workspace > Settings > Accounts > Failed Login Attempts tab.

Field

Description

Enable collect login data

When this option is enabled, it allows collecting failed login attempts.

Block failed login attempts by Username

Enable this option to automatically block failed login attempts with username.

Amount of failed attempts before blocking user

Set the number of failed login attempts before blocking the user automatically.

Duration of user block (in minutes)

Set the duration of time (in minutes) for which the user is blocked. After this time passes, the user is unblocked.

Block failed login attempts by IP

Enable this option to block IP addresses after failed login attempts.

Amount of failed attempts before blocking IP address

Set the number of failed login attempts before automatically blocking an IP address.

Duration of IP address block (in minutes)

Set the duration of time (in minutes) for which an IP is blocked.

IP Whitelist

Enter a list of comma-separated IP addresses to be whitelisted.

Notify of failed login attempts

When this option is enabled, a channel is notified of all failed login attempts.

Channel to send the notifications

Enter the channel to which the failed login attempts are sent. Make sure that the channel exists and enter the channel name without the # symbol.

Login logs settings

To access these settings, go to Administration > Workspace > Settings > Accounts > Login Logs tab.

Field

Description

Log (on console) failed login attempts

Enable this option to log all failed login attempts on the console.

Show Username on failed login attempts logs

When this option is enabled, usernames are shown on the console for all failed login attempts.

Show UserAgent on failed login attempts logs

Enable this option to display the user agent on failed login attempts.

Show Client IP on failed login attempts logs

Enable this option to display the client IP address on the console on any failed login attempt.

Show Forwarded IP on failed login attempts logs

Enable this option to display the forwarded IP on any failed login attempts.

Configure user registration settings

To access these settings, go to Administration > Workspace > Settings > Accounts > Registration tab.

Field

Description

Send email to user when user is activated

Enable this option to send an email to the user after their account has been activated. Make sure that email has been configured on your workspace. A new user account is activated once they log in to the workspace.

Send email to user when user is deactivated

If this option is enabled, users get an email after account deactivation. Make sure that email has been configured on your workspace. Admins can deactivate users from the Users tab.

Default username prefix suggestion

This is the prefix that is suggested when a user is creating a username. The default value is user.

Require Name For Signup

If this option is enabled, the name of the user is required to create an account.

Require Password Confirmation

If this option is enabled, the user has to enter their password twice when registering.

Require email verification to login

Enable this option to allow only verified users only to log in. Email verification can be done when a user creates an account. Admins can manually verify a user’s email from the Users tab.

Mark Email for External Accounts Verified

If this option is enabled, users must confirm their email via a confirmation email sent to their email. (For this setting to work, the SMTP settings must be already set up. See Email Configuration.)

Manually Approve New Users

If this option is enabled, new users must wait for a user with the view-user-administration permission to approve their account before using the workspace.

Admins can manage this on the Users page (from the Pending tab).

Allowed Domains List

Enter a comma-separated list of email domains that are allowed.

Blocked Domains List

Enter a comma-separated list of email domains that are not allowed to be used on the workspace.

Blocked Username List

Enter a comma-separated list of usernames (case-insensitive) to be blocked.

Use Default Blocked Domains List

Enable this option to block the email domains listed here.

Use DNS Domain Check

When this option is enabled, users cannot register with invalid domains.

Registration Form

Select how the registration form is presented. The options are as follows:

  • Public: The form is made public, and anyone can access it.

  • Disabled: The form is disabled, and users can not register through it.

  • Secret URL: The form is only accessible using a specific URL.

Registration Form Secret URL

Enter a string to be added to the secret URL. A random string is recommended for that. For example: https://open.rocket.chat/register/[secret_hash]. Copy this URL to share the form with anyone.

Invite URL Type

The URL type can either be direct or through a proxy.

Registration Form Link Replacement Text

Enter the text to be displayed in place of the registration form when it is disabled.

Registration with Authentication Services

Enable this option to allow registration with third-party authentication services like Google or Twitter.

Default Roles for Authentication Services

Enter the default roles (comma-separated values) that users are given when registering through authentication services.

Default Roles for Users

Enter the default roles (comma-separated values) that users are given when registering through manual registration, including via API.

Password Reset

Enable this option to allow users to reset their password.

Custom Fields

Enter valid JSON key-value pairs of additional fields to be added during user registration. See Configuring Custom Fields for details.

Reset defaults

Click the button to return configurations to their default values.