Manage Custom Sounds and Emojis

Rocket.Chat provides various customization options to control the look and behavior of your workspace. These features are great personalization tools for your workspace.

This document guides you through the custom sounds and emoji options.

Manage custom sounds

Rocket.Chat allows you to add sound files that can be used within your workspace. You can assign a chat activity to a particular sound. For example, select a sound to be played whenever you are added to a new room.

Configure custom sound storage

Before you add sound files, you can choose where to store the custom sounds uploaded. By default, GridFS within MongoDB is used. You can specify a valid storage path on your Rocket.Chat server if you prefer local storage. To configure this setting, go to Administration > Workspace > Settings > Custom Sound Filesystem. Update the following fields:

Field	Description
Storage Type	Select how you want to store sounds, either GridFS or Filesystem. GridFS is the default storage system for custom sounds in Rocket.Chat. FileSystem stores custom sounds directly on the local storage of the server running the Rocket.Chat instance.
System Path	If you select FileSystem as the storage type, specify a valid path on the server hosting Rocket.Chat where custom sounds will be stored. For example, using `/sounds` will store your custom sounds in a `sounds` directory at the root level of your server. For Docker deployments, access the Rocket.Chat server with `docker exec -it <container-name> sh` to verify the uploaded sounds.

Field

Description

Storage Type

Select how you want to store sounds, either GridFS or Filesystem.

GridFS is the default storage system for custom sounds in Rocket.Chat.
FileSystem stores custom sounds directly on the local storage of the server running the Rocket.Chat instance.

System Path

If you select FileSystem as the storage type, specify a valid path on the server hosting Rocket.Chat where custom sounds will be stored. For example, using /sounds will store your custom sounds in a sounds directory at the root level of your server.

For Docker deployments, access the Rocket.Chat server with docker exec -it <container-name> sh to verify the uploaded sounds.

Click Save changes once you are done.

Restart the server for the updated storage settings to take effect.

Add custom sounds

Now that the storage is configured, you can upload custom sounds to your workspace. To add a new sound, follow these steps:

Go to Administration > Workspace > Sounds.
Click the New button at the top right.
Enter a name for your sound.
Upload a sound file in mp3 format.
Click Save. After it is saved successfully, it is added to the list of sounds.

Use the custom sounds

After adding a sound, workspace users can select a chat activity to be associated with that sound.

See Account - Sound to know more about choosing sounds for chat activities in your workspace.
You can also personalize the sound of notifications in a channel. See Room Actions - Notification preferences to learn how to use your sound for channel notifications.

Edit and delete sounds

Admins can modify existing custom sounds. On the Administration > Workspace > Sounds page, select the sound you want to edit or delete. Update the sound details and click Save. Click the Delete button to delete the sound.

Manage custom emojis

Rocket.Chat allows you to add emoji files that can be used within Rocket.Chat workspace. Emojis are a great way of filling emotional cues.

Configure custom emoji storage

Before you add emoji files, you can choose where to store the custom emojis uploaded. By default, GridFS within MongoDB is used. You can specify a valid storage path on your Rocket.Chat server if you prefer local storage. To configure this setting, go to Administration > Workspace > Settings > Custom Emoji Filesystem. Update the following fields:

Field	Description
Storage Type	Select how you want to store emojis, either GridFS or Filesystem. GridFS is the default storage system for custom emojis in Rocket.Chat. Filesystem stores custom emojis directly on the local storage of the server running the Rocket.Chat instance.
System Path	If you select Filesystem as the storage type, specify a valid path on the server hosting Rocket.Chat where custom emojis will be stored. For example, using `/emojis` will store your custom emojis in an `emojis` directory at the root level of your server. For Docker deployments, access the Rocket.Chat server with `docker exec -it <container-name> sh` to verify the uploaded emojis.

Field

Description

Storage Type

Select how you want to store emojis, either GridFS or Filesystem.

GridFS is the default storage system for custom emojis in Rocket.Chat.
Filesystem stores custom emojis directly on the local storage of the server running the Rocket.Chat instance.

System Path

If you select Filesystem as the storage type, specify a valid path on the server hosting Rocket.Chat where custom emojis will be stored. For example, using /emojis will store your custom emojis in an emojis directory at the root level of your server.

For Docker deployments, access the Rocket.Chat server with docker exec -it <container-name> sh to verify the uploaded emojis.

Click Save changes once you are done.

Restart the server for the updated storage settings to take effect.

Add custom emojis

Now that the storage is configured, you can upload custom emojis to your workspace. To add a new emoji, follow these steps:

Go to Administration > Workspace > Emoji.
Click the New button on the top right.
Enter a name for your emoji.
Enter an alias for your emoji.
Browse and choose an image file in the PNG or JPEG format.
Click Save.

Use the custom emojis

To use an emoji that you've added, either click the emoji icon on the message input and search for your emoji by its name or enter :emoji_name: or :emoji_alias: in the message box to directly add the emoji.

Edit and delete emojis

Admins can modify existing custom emojis. On the Administration > Workspace > Emoji page, select the emoji you want to edit or delete. Update the emoji details and click Save. Click the Delete button to delete the emoji.