# Redis Destination Config Reference


> Complete Rudder CLI reference for the Redis destination config keys, cluster and TLS settings, and secrets.



[Redis](https://www.rudderstack.com/docs/destinations/streaming-destinations/redis/) is a key-value store destination. RudderStack writes the traits from each `identify` event to the user's key in Redis — `user:<userId>` — so you can read a user's latest profile in real time. Redis receives only `identify` events, and only those with a `userId`. One without fails.

In a Redis destination spec:

- `type: redis`
- `definition_version: 1`

## Sample configuration

```yaml
version: rudder/v1
kind: destination
metadata:
  name: redis-prod
spec:
  id: redis-prod
  display_name: Redis Production
  type: redis
  definition_version: 1
  enabled: true
  config:
    address: redis.internal.example.com:6379
    password: "{{ .REDIS_PASSWORD }}"
    cluster_mode: false
    database: "2"
    prefix: rudderstack

    secure: true
    skip_verify: false
    ca_certificate: "{{ .REDIS_CA_CERTIFICATE }}"

    use_json_module: false

    connection_mode:
      web: cloud
      cloud: cloud
    consent_management:
      web:
        - provider: oneTrust
          consents:
            - analytics
```

The above example connects to a single Redis server over TLS. `cluster_mode` defaults to `true`, so a single server needs `cluster_mode: false`, which also lets it pick a `database` — see [Connection](#connection).

## Config keys

`config` accepts only the keys listed below. The [shared config key rules](https://www.rudderstack.com/docs/rudder-cli/destination-types/#config-key-rules) cover unknown keys, defaults, and immutability.

### Connection

<div class="rs-ckeys">
<div class="rs-ckey" id="address">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">address</p>Required</div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Address of your Redis server, as <code>host:port</code>. With <code>cluster_mode</code> on, list several cluster nodes separated by commas.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>At most 100 characters, and must not contain line breaks or <code>.ngrok.io</code>.</li>
<li>A <code>{{ path || fallback }}</code> template is accepted in place of a literal, but RudderStack connects with the value as written, without resolving it.</li>
</ul>

</div>

</div>

<div class="rs-ckey" id="password">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">password</p>Secret</div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Password RudderStack authenticates to Redis with. Omit it for a server without authentication.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Not validated locally.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  Supply it as a <code>{{ .VAR }}</code> reference rather than a literal — see <a href="#secrets" >Secrets</a>.
</div>

</div>

<div class="rs-ckey" id="cluster_mode">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">cluster_mode</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>boolean</code>
  </p><p class="rs-ckey__field">
    Default value:
    <code>true</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Connect to a Redis Cluster, with <code>address</code> listing its nodes. Set it to <code>false</code> for a single Redis server.
</p>

</div>

<div class="rs-ckey" id="database">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">database</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Number of the database RudderStack writes to. When it&rsquo;s omitted, RudderStack uses database <code>0</code>.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Applies when <code>cluster_mode</code> is <code>false</code>. Leave it unset otherwise.</li>
<li>Written as a string, not a number — an unquoted number fails validation.</li>
<li>At most 100 characters, and must not contain line breaks. A value that isn&rsquo;t a number passes validation, and RudderStack then uses database <code>0</code>.</li>
<li>A <code>{{ path || fallback }}</code> template is accepted in place of a literal, but RudderStack connects with the value as written, without resolving it.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  <div class="rs-code">
  <div class="rs-code__head">yaml<button class="rs-code__copy" type="button">
      
      Copy
    </button>
  </div>
  <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">cluster_mode: false
database: &#34;2&#34;</code></pre></div>
</div>
</div>

</div>

<div class="rs-ckey" id="prefix">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">prefix</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Prefix for the keys RudderStack writes: <code>&lt;prefix&gt;:user:&lt;userId&gt;</code> instead of <code>user:&lt;userId&gt;</code>.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>At most 100 characters, and must not contain line breaks.</li>
<li>A <code>{{ path || fallback }}</code> template is accepted in place of a literal.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  See <a href="https://www.rudderstack.com/docs/destinations/streaming-destinations/redis/#custom-prefix" >Custom prefix</a>.
</div>

</div>

</div>

### TLS

<div class="rs-ckeys">
<div class="rs-ckey" id="secure">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">secure</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>boolean</code>
  </p><p class="rs-ckey__field">
    Default value:
    <code>false</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Connect to Redis over TLS.
</p>

</div>

<div class="rs-ckey" id="skip_verify">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">skip_verify</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>boolean</code>
  </p><p class="rs-ckey__field">
    Default value:
    <code>false</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Skip verifying the server&rsquo;s certificate chain and host name. That leaves the connection open to man-in-the-middle attacks, so use it only for testing, for example against a self-signed certificate.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Applies when <code>secure</code> is <code>true</code>.</li>
</ul>

</div>

</div>

<div class="rs-ckey" id="ca_certificate">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">ca_certificate</p>Secret</div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p>
<p class="rs-ckey__field">
  Description:
  PEM-encoded CA certificate RudderStack verifies the server&rsquo;s certificate against. Omit it when any client can verify the server&rsquo;s CA, as with Amazon ElastiCache.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Applies when <code>secure</code> is <code>true</code>. Leave it unset otherwise.</li>
<li>Not validated locally.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  <p>Supply it as a <code>{{ .VAR }}</code> reference rather than a literal — see <a href="#secrets" >Secrets</a> for passing its line breaks.</p>
<p>See <a href="https://www.rudderstack.com/docs/destinations/streaming-destinations/redis/#how-do-i-set-up-redis-on-docker-with-tls-support" >How do I set up Redis on Docker with TLS support?</a> for a local TLS setup.</p>

</div>

</div>

</div>

### Storage format

By default, each user's key holds a Redis hash. RudderStack merges `context.traits` and `traits` into it, with `traits` winning, flattens nested traits with `.` — `location.city` — and stores every value as a string. Fields the event doesn't carry are left as they were. See [Identify](https://www.rudderstack.com/docs/destinations/streaming-destinations/redis/#identify) for an example.

<div class="rs-ckeys">
<div class="rs-ckey" id="use_json_module">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">use_json_module</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>boolean</code>
  </p><p class="rs-ckey__field">
    Default value:
    <code>false</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Store each user&rsquo;s traits as a JSON document instead of a hash. RudderStack merges each <code>identify</code> event&rsquo;s traits into the user&rsquo;s existing document.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Needs the RedisJSON module on your Redis server.</li>
<li>The dashboard shows this setting only to workspaces with the feature turned on.</li>
</ul>

</div>

</div>

</div>

### Per-source keys

Both keys are objects keyed by the local source type — the tokens listed under [Source types](#source-types). A key naming a source type this destination doesn't support fails validation.

<div class="rs-ckeys">
<div class="rs-ckey" id="connection_mode">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">connection_mode</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>object</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Maps each source type you connect to the mode its events reach Redis in, using the modes in <a href="#source-types" >Source types</a>.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>An entry is required for each source type you connect — see <a href="#connect-a-source" >Connect a source</a>.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  <div class="rs-code">
  <div class="rs-code__head">yaml<button class="rs-code__copy" type="button">
      
      Copy
    </button>
  </div>
  <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">connection_mode:
  web: cloud
  cloud: cloud</code></pre></div>
</div>
</div>

</div>

<div class="rs-ckey" id="consent_management">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">consent_management</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>object</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Consent provider configuration per source type. The entry shape, accepted providers, and the rules on <code>resolution_strategy</code> and <code>consents</code> are shared across all destination types — see <a href="https://www.rudderstack.com/docs/rudder-cli/destination-types/#consent-management" >Consent management</a>.
</p>

</div>

</div>

## Source types

Redis accepts events from these source types in the mentioned connection modes:

| Source type | Connection mode |
| :-----| :-----|
| `android` | `cloud` |
| `android_kotlin` | `cloud` |
| `ios` | `cloud` |
| `ios_swift` | `cloud` |
| `web` | `cloud` |
| `unity` | `cloud` |
| `react_native` | `cloud` |
| `flutter` | `cloud` |
| `cordova` | `cloud` |
| `cloud` | `cloud` |
| `warehouse` | `cloud` |

Every source type is `cloud` only — events reach Redis from RudderStack's servers, never in device mode.

`warehouse` is the token a [Reverse ETL source](https://www.rudderstack.com/docs/sources/reverse-etl/) resolves to. Rudder CLI manages the destination’s `warehouse` entry — if the destination is connected to a Reverse ETL source, set `connection_mode.warehouse: cloud` in its spec, or `apply` removes it.

Rudder CLI can also declare the Reverse ETL connection itself, for the types listed under [Supported destinations](https://www.rudderstack.com/docs/rudder-cli/yaml-retl-connections/#supported-destinations) — see [Manage Reverse ETL Connections using Rudder CLI](https://www.rudderstack.com/docs/rudder-cli/retl-connections/).

**Info:** The dashboard additionally offers Redis to AMP and Shopify sources. Rudder CLI doesn&#39;t manage those connections, so `amp` and `shopify` are invalid here.

## Connect a source

An event stream connection to this destination is checked against two rules at `validate` time.

**The source's type must be supported.** A source's type resolves to one of the tokens above before the check — a JavaScript source resolves to `web`, and webhook and server-side SDK sources resolve to `cloud`. Every type an event stream source can resolve to is supported here, so this check always passes.

**The destination config must carry a `connection_mode` entry for that source type.** This lives on the destination spec, not on the [connection spec](https://www.rudderstack.com/docs/rudder-cli/yaml-connections/). Without it:

```text
destination 'redis-prod' config has no 'connection_mode' entry for source type 'web'
```

Redis needs no additional config keys to connect a source of any type.

## Secrets

`password` and `ca_certificate` are the secret keys. Write each as a `{{ .VAR }}` reference and supply the value at apply time:

```yaml
config:
  password: "{{ .REDIS_PASSWORD }}"
  ca_certificate: "{{ .REDIS_CA_CERTIFICATE }}"
```

```bash
export RUDDER_REDIS_PASSWORD="..."
export RUDDER_REDIS_CA_CERTIFICATE="$(cat ca.pem)"
rudder-cli apply

# or
rudder-cli apply --var-file secrets.vars.yaml
```

Note that:

- `rudder-cli import` writes only the secrets the API returns, as `{{ .VAR }}` references, and leaves the others out. Add any secret key it leaves out, then supply the variables before you apply — see [Secrets](https://www.rudderstack.com/docs/rudder-cli/destination-types/#secrets).
- `ca_certificate` spans several lines. Keep its reference quoted and on its own, as above, and supply the certificate with its line breaks — as is from the environment, or as a `|` block in a var file. A bare reference, or one inside a longer string, breaks the YAML or folds the line breaks into spaces.
- A certificate with its line breaks written as `\n` also works, but only inside a double-quoted reference. A single-quoted reference, like the ones `rudder-cli import` writes, keeps the `\n` as literal text.

See [How to Use Variable Substitution in Rudder CLI](https://www.rudderstack.com/docs/rudder-cli/variable-substitution/).

## Changes by release

<p>No changes since this type became available.</p>

For changes across every destination type, see [Destination Type Changes by Release](https://www.rudderstack.com/docs/rudder-cli/destination-types/changes/).

## See more

- [Redis Destination](https://www.rudderstack.com/docs/destinations/streaming-destinations/redis/) for how RudderStack stores traits, custom prefixes, and deleting a user
- [Destination Type Reference for Rudder CLI](https://www.rudderstack.com/docs/rudder-cli/destination-types/) for the rules shared across destination types
- [Destination YAML Reference](https://www.rudderstack.com/docs/rudder-cli/yaml-destinations/) for the spec envelope