<a id="ref-replicator-config"></a>

# Replicator configuration

Each replicator has its own key/value configuration with the following supported namespaces:

- [Replicator options](#ref-replicator-config-options)
- [Miscellaneous options](#ref-replicator-config-misc)

<a id="ref-replicator-config-options"></a>

## Replicator options

The following keys are currently supported:

<!-- Include content from [../metadata.txt](../metadata.txt) -->

<a id="replicator-conf:cluster"></a>
`cluster`

Target cluster link name.

[<i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i>](#replicator-conf:cluster)

| **Key:**    | `cluster`   |
|-------------|-------------|
| **Type:**   | string      |
| **Scope:**  | global      |

Required when creating a replicator.

<a id="replicator-conf:schedule"></a>
`schedule`

Cron expression for the replication schedule.

[<i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i>](#replicator-conf:schedule)

| **Key:**    | `schedule`   |
|-------------|--------------|
| **Type:**   | string       |
| **Scope:**  | global       |

Specify a cron expression for the replication schedule. For example, `@daily` or `0 6 * * *`.

<a id="ref-replicator-config-misc"></a>

## Miscellaneous options

<!-- Include content from [../metadata.txt](../metadata.txt) -->

<a id="replicator-miscellaneous:user.*"></a>
`user.*`

Free form user key/value storage

[<i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i>](#replicator-miscellaneous:user.*)

| **Key:**    | `user.*`   |
|-------------|------------|
| **Type:**   | string     |

User keys can be used in search.
