relay ConVars

Every variable and command in the relay namespace that a Rust dedicated server lists, 21 in all, with the help text it printed and the value we read. How to set them is on the ConVar overview.

Recorded on Rust build 25582902, . Values are what that server returned, which is not always the default.

21 entries

Variables 11

ConVarValueDescription
relay.cfg_autoreconnectTrueIf enabled, Rust Relay will automatically attempt to reconnect when the WebSocket connection drops
relay.cfg_encryptpacketsFalseSets whether packets should be encrypted when sent to the Rust Relay server, changing this will STOP the Rust Relay feature (restart with relay.restart)
relay.cfg_fakeplayerFalseIf enabled, Rust Relay spawns a fake invisible player and only relays packets sent to that player, changing this will STOP the Rust Relay feature (restart with relay.restart)
relay.cfg_filtermode0Sets the Filter Mode for RPC Messages, (0 = Ignore, 1 = AllowAll, 2 = AllowWhitelist)
relay.cfg_maxreconnects5Maximum number of reconnect attempts allowed within the reconnect window before the relay permanently shuts down
relay.cfg_reconnectdelay5Delay (in seconds) between reconnect attempts
relay.cfg_reconnectwindow30The rolling window (in minutes) used to track reconnect attempts
relay.cfg_sendconsoledataTrueIf enabled, console data will be sent to the relay server
relay.cfg_sendvoicedataFalseIf enabled, voice data will be sent to the relay server
relay.cfg_server_auth_token""Sets the authentication token for the Rust Relay server, changing this will STOP the Rust Relay feature (restart with relay.restart)
relay.cfg_server_url""Sets the URL for the Rust Relay server, changing this will STOP the Rust Relay feature (restart with relay.restart)

Commands 10

CommandDescription
relay.cfg_reloadReloads the Rust Relay configuration from disk, this will STOP the Rust Relay feature (restart with relay.restart)
relay.cfg_saveForces a save of the Rust Relay configuration to disk
relay.clear_queueClears the relay send queue (useful if things are going wrong with the relay server)
relay.reconnect_resetClears the reconnect attempt history, resetting the reconnect budget
relay.restartAttempts to restart the Rust Relay connection (may cause short lag)
relay.rpc_whitelist_addAdds an RPC Message to the RPC Whitelist
relay.rpc_whitelist_rebuildRebuilds the RPC Whitelist ID List
relay.rpc_whitelist_removeRemoves an RPC Message from the RPC Whitelist
relay.shutdownShutsdown the Rust Relay sever connection
relay.statusReturns a detailed Rust Relay status report

Back to the list of all namespaces.

Skip the manual work: install the Panelra agent

Wipes, updates, restarts, plugins and crash alerts for your Rust servers, from one dashboard. One install command on your Linux host, no inbound ports for the agent.

Free during the open beta. Pricing will be announced before the beta ends.