remotes
List of entries specifiying servers where the leaf node client connection can be made.
Properties
| Name | Description | Type | Default | Reloadable |
|---|---|---|---|---|
url | URL or list of URLs of a remote server accepting leaf node connections. If username/password or token authentication is required on the remote, this should be encoded in the URL itself, e.g. nats-leaf://username:password@localhost:7422. Note, the URL scheme should be nats-leaf or ws. | (multiple) | - | Yes |
nkey | User nkey seed this remote authenticates with. | string | - | Yes |
first_info_timeout | How long to wait for the remote's INFO message before giving up on the connection. | duration | 1s | No |
disabled | Keep the remote in the configuration without connecting to it. | boolean | false | Yes |
isolate_leafnode_interest | Do not propagate subscription interest learned from this remote to other leaf nodes on this server. | boolean | false | No |
request_isolation | Ask the remote to isolate this connection's interest on its side. | boolean | false | No |
ignore_discovered_servers | Connect only to the URLs listed here, ignoring any additional servers the remote advertises. | boolean | false | No |
proxy | Reach the remote through an HTTP proxy. | object | - | No |
no_randomize | If true and more than one URL is specified, the first one in the list will be used. If the client disconnects from the server, then the next URL will be used in order. | boolean | - | No |
account | Account name or public NKey identifying the local account to bind to this remote server. Any traffic locally on this account will be forwarded to the remote server. | string | - | Yes |
credentials | Path to a credentials file. This is application when decentralized auth is used on the remote. | string | - | Yes |
tls | TLS configuration for connecting/authenticating with the remote if mutual TLS is required. | object | - | Yes* |
hub | boolean | - | No | |
deny_imports | (multiple) | - | No* | |
deny_exports | (multiple) | - | No* | |
ws_compression | If true, and connecting with the WebSocket protocol, the connection will indicate to the remote that it wishes compression to be used. | boolean | false | No |
ws_no_masking | If true and connecting with the WebSocket protocol, the connection will indicate to the remote that it wishes not to mask outbound WebSocket frames. | boolean | false | No |
jetstream_cluster_migrate | boolean | true | No | |
compression | Defines the compression mode to use for a outgoing leafnode connection. If set to on, it will use the s2_auto. | (multiple) | - | Yes* |
* See the property page for reload caveats.