Skip to main content
Version: 2.12

remotes

List of entries specifiying servers where the leaf node client connection can be made.

Properties

NameDescriptionTypeDefaultReloadable
urlURL 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
no_randomizeIf 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-Yes
accountAccount 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
credentialsPath to a credentials file. This is application when decentralized auth is used on the remote.string-Yes
tlsTLS configuration for connecting/authenticating with the remote if mutual TLS is required.object-Yes
hubboolean-Yes
deny_imports(multiple)-Yes
deny_exports(multiple)-Yes
ws_compressionIf true, and connecting with the WebSocket protocol, the connection will indicate to the remote that it wishes compression to be used.booleanfalseYes
ws_no_maskingIf true and connecting with the WebSocket protocol, the connection will indicate to the remote that it wishes not to mask outbound WebSocket frames.booleanfalseYes
jetstream_cluster_migratebooleantrueYes
compressionDefines the compression mode to use for a outgoing leafnode connection. If set to on, it will use the s2_auto.(multiple)-Yes