---
title: "Manage Settings Using Environment Variables"
slug: "manage-settings-using-environmental-variables"
description: "Learn to manage Rocket Chat settings using environment variables. Enable secure messaging, scalability, and reliable collaboration with flexible configuration."
updated: 2026-05-04T21:33:31Z
published: 2026-05-04T22:27:01Z
canonical: "docs.rocket.chat/manage-settings-using-environmental-variables"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Manage Settings Using Environmental Variables

Rocket.Chat allows you to manage workspace settings using environment variables instead of updating them through the admin UI or database. This approach is useful for automating deployments and maintaining consistent configurations across environments.

This guide explains how to configure settings with environment variables and outlines the supported data types.

---

## Get a setting ID

To manage a setting using an environment variable, you need its **setting ID**.

Hover over a setting name in **Administration > Workspace > Settings** to view its ID in the tooltip.

![](https://cdn.us.document360.io/6ae79a05-7252-45d0-96e8-8f375e07b1b2/Images/Documentation/Manage Settings Using Environmental Variables.avif)

---

## Set environment variables

Each [deployment method](/v1/docs/deploy-rocketchat) provides its own way to define environment variables. Refer to the appropriate guide:

1. **Docker**: Refer to [Set Rocket.Chat deployment environment variable on Docker](/v1/docs/deploy-with-docker-docker-compose#set-rocketchat-deployment-environment-variable-on-docker).
2. **Kubernetes**: Visit the [Set Rocket.Chat deployment environment variable on Kubernetes](/v1/docs/deploy-with-kubernetes#set-rocketchat-deployment-environment-variable-on-kubernetes) guide.
3. **Podman**: Go to [Set Rocket.Chat deployment environment variable on Podman](/v1/docs/deploy-with-podman#set-rocketchat-deployment-environment-variable-on-podman).

> [!NOTE]
> The examples in this guide follow the [Docker](/v1/docs/deploy-with-docker-docker-compose#set-rocketchat-deployment-environment-variable-on-docker) setup.

---

## Configure settings with environment variables

Using environment variables in Rocket.Chat, you can:

- Set initial values for settings
- Override existing values
- Block settings from being changed
- Hide settings

The following sections describe each option.

### Set the initial value for a setting

To define a setting value when the server starts for the first time, use:

```plaintext
SETTING_ID=VALUE
```

For example:

```plaintext
FileUpload_Storage_Type: GoogleCloudStorage
```

> [!WARNING]
> This applies only if the setting has not been configured previously in the UI or database. If the setting already has a value, use [Overwrite the setting value](/v1/docs/manage-settings-using-environmental-variables#overwrite-the-setting-value).

### Overwrite the setting value

To overwrite an existing setting value, prefix the setting ID with `OVERWRITE_SETTING_`. For example:

```plaintext
OVERWRITE_SETTING_FileUpload_Storage_Type: GoogleCloudStorage
```

### Block settings

To prevent a setting from being changed through the UI or API, use `SETTINGS_BLOCKED` with a comma-separated list of setting IDs. For example:

```plaintext
SETTINGS_BLOCKED: FileUpload_Storage_Type,FileUpload_GoogleStorage_AccessId,FileUpload_GoogleStorage_Secret
```

To unblock any setting, remove it from the list and restart your Rocket.Chat server.

### Hide settings

To hide sensitive settings from appearing in the workspace UI, use the `SETTINGS_HIDDEN` variable with a comma-separated list of setting IDs you want to hide: For example:

```plaintext
SETTINGS_HIDDEN: FileUpload_GoogleStorage_AccessId,FileUpload_GoogleStorage_Secret
```

> [!NOTE]
> Use this command with extreme caution. Avoid hiding settings required by the Rocket.Chat client, such as `FileUpload_Storage_Type`, as this can break functionality.

## Setting metadata and data types

To use environment variables effectively, it helps to understand the structure of each setting. Each setting includes metadata like its ID, type, default value, and visibility. When setting values via environment variables, you must use the correct data type—e.g., string, boolean, number, etc.

### Basic settings

| Name | Data Type |
| --- | --- |
| `_id` | `SettingId` = string |
| `type` | - boolean - timezone - string - relativeUrl - password - int - select - multiSelect - language - color - font - code - action - asset - roomPick - group - date |
| `public` | boolean |
| `env` | boolean |
| `group` (Optional) | `GroupId` = `SettingId` |
| `section` (Optional) | `SectionName` = string |
| `tab` (Optional) | `TabId` = `SettingId` |
| `i18nLabel` | string |
| `value` | `SettingValue` can be one of the following types: - string - boolean - number - SettingValueMultiSelect - Date - AssetValue - undefined |
| `packageValue` | `SettingValue` can be one of the following types: - string - boolean - number - SettingValueMultiSelect - Date - AssetValue - undefined |
| `blocked` | boolean |
| `enableQuery` (Optional) | string |
| `displayQuery` (Optional) | string |
| `sorter` | number |
| `properties` (Optional) | unknown |
| `enterprise` (Optional) | boolean |
| `requiredOnWizard` (Optional) | boolean |
| `hidden` (Optional) | boolean |
| `modules` (Optional) | Array |
| `invalidValue` (Optional) | `SettingValue` can be one of the following values: - string - boolean - number - SettingValueMultiSelect - Date - AssetValue - undefined |
| `valueSource` (Optional) | string |
| `secret` (Optional) | boolean |
| `i18nDescription` (Optional) | string |
| `autocomplete` (Optional) | boolean |
| `processEnvValue` (Optional) | `SettingValue` can be one of the following values: - string - boolean - number - SettingValueMultiSelect - Date - AssetValue - undefined |
| `meteorSettingsValue` (Optional) | `SettingValue` can be one of the following values: - string - boolean - number - SettingValueMultiSelect - Date - AssetValue - undefined |
| `ts` | Date |
| `createdAt` | Date |
| `_updatedAt` (Optional) | Date |
| `multiline` (Optional) | boolean |
| `values` (Optional) | Array |
| `placeholder` (Optional) | string |
| `wizard` (Optional) | - `step`: number - `order`: number |
| `persistent` (Optional) | boolean |
| `readonly` (Optional) | boolean |
| `alert` (Optional) | string |
| `private` (Optional) | boolean |

### Group settings

| Name | Data Type |
| --- | --- |
| `_id` | string |
| `hidden` | boolean |
| `blocked` | boolean |
| `ts` | Date |
| `sorter` | number |
| `i18nLabel` | string |
| `displayQuery` | string |
| `i18nDescription` | string |
| `value` | undefined |
| `type` | group |
| `alert` | string |

### Enterprise settings

| Name | Data Type |
| --- | --- |
| `enterprise` | true |
| `invalidValue` | `SettingValue` can be one of the following values: - string - boolean - number - SettingValueMultiSelect - Date - AssetValue - undefined |

### Color settings

| Name | Data Type |
| --- | --- |
| `type` | color |
| `editor` | SettingEditor |
| `packageEditor` (Optional) | SettingEditor |

### Action settings

| Name | Data Type |
| --- | --- |
| `type` | action |
| `value` | string |
| `actionText` (Optional) | string |

### Code settings

| Name | Data Type |
| --- | --- |
| `type` | action |
| `value` | string |
| `actionText` (Optional) | string |

### Asset settings

| Name | Data Type |
| --- | --- |
| `type` | asset |
| `value` | AssetValue |
| `fileConstraints` | IRocketChatAssetConstraint |
| `asset` | string |

### SelectOption settings

| Name | Data Type |
| --- | --- |
| `key` | The type can be: - string - number |
| `i18nLabel` | string |

### Editor settings

| Name | Data Type |
| --- | --- |
| `COLOR` | color |
| `EXPRESSION` | expression |

### Date settings

| Name | Data Type |
| --- | --- |
| `type` | Date |
| `value` | Date |

### Statistics settings

| Name | Data Type |
| --- | --- |
| `account2fa` (Optional) | boolean |
| `cannedResponsesEnabled` (Optional) | boolean |
| `e2e` (Optional) | boolean |
| `e2eDefaultDirectRoom` (Optional) | boolean |
| `e2eDefaultPrivateRoom` (Optional) | boolean |
| `smtpHost` (Optional) | string |
| `smtpPort` (Optional) | string |
| `fromEmail` (Optional) | string |
| `fileUploadEnable` (Optional) | boolean |
| `frameworkDevMode` (Optional) | boolean |
| `frameworkEnable` (Optional) | boolean |
| `surveyEnabled` (Optional) | boolean |
| `updateChecker` (Optional) | boolean |
| `liveStream` (Optional) | boolean |
| `broadcasting` (Optional) | boolean |
| `allowEditing` (Optional) | boolean |
| `allowDeleting` (Optional) | boolean |
| `allowUnrecognizedSlashCommand` (Optional) | boolean |
| `allowBadWordsFilter` (Optional) | boolean |
| `readReceiptEnabled` (Optional) | boolean |
| `readReceiptStoreUsers` (Optional) | boolean |
| `pushEnable` (Optional) | boolean |
| `globalSearchEnabled` (Optional) | boolean |
| `threadsEnabled` (Optional) | boolean |
| `bigBlueButton` (Optional) | boolean |
| `jitsiEnabled` (Optional) | boolean |

Environment variables provide a controlled way to manage workspace settings during deployment. Use them to define initial values, enforce overrides, and restrict or hide settings where necessary. Always ensure that values match the expected data type.