Rust Wiki

Rust+ Server

Rust+ Server

About

The Companion Server is what Rust+ uses to communicate with Rust servers. If something is wrong with it then nobody will be able to view your server in Rust+, even if they pair with it. They will see it loading for a while before it says the server is offline.

Making it work

For most people, the only requirement for the companion server to work is to make the TCP port the companion server listens on accessible over the internet. Port forward, open it, add firewall rules for it.

You can use the app.info command on your server to show what port the companion server is using. If you need to switch it to something else, you can specify the port to use in the app.port convar. This port must be 10000 or greater for Rust+ to connect to it. You will need to restart your Rust server for the port change to take effect.

If you have a more complicated networking setup where you need to specify which NIC to listen on then you'll need to set the app.listenip convar to your Rust server's public IP address. You can check the connection settings the server is currently using with the app.info command. If the IP address that the app connects to is incorrect, you can set it app.publicip to the value you need.

If you get errors about companion server registration or push notifications aren't working then make sure your server can access companion-rust.facepunch.com over the internet.

If everything is still broken you can submit feedback using this form.

Checking if it works

The most straight forward way to test is by pairing with the app itself - but if you have many servers there's an easier way. You can use a tool like Postman to test connections to the companion server. Simply create a new WebSocket request and type in the Rust server's IP address and companion server port into the "Server URL" field. For example: ws://99.99.99.99:11111. Press the "Connect" button and you'll see if it connected successfully in the messages log below.

The "companion.id" file

You may have noticed a companion.id file in your server's save folder recently. This file represents your server's identity to Rust+ and should always be kept with your server and its backups.

Here's a list of rules for this file:

  • Do not give it to anyone else.
  • Do not use someone else's file.
  • Do not use the same file on multiple servers.
  • Do not randomly delete it.
  • Do not change the "app.id" convar.

Breaking any of those rules will make your server behave weirdly in Rust+, disable notification permission for all your players, and probably require all players to re-pair with your server.

A brand new identity will be generated for your server if you do delete it. There's no getting it back once it's gone!

Disabling Rust+ on your server

If you need to disable Rust+ on your server for whatever reason, the proper way to do so is to set app.port to -1 in your server command line (note: due to command line parser conflicts you will need to specify it as +app.port 1-). This is the only way to turn it off entirely. Players will be able to see that Rust+ is disabled if they open the Rust+ menu on their clients while connected to your server.

Automatic connectivity testing

An automatic connectivity test was added into the Rust server to disable Rust+ on servers that are not configured properly to allow connections to the Rust+ companion server. If a server fails this test, it will automatically disable Rust+ on the server and players will see that in the in-game Rust+ menu. This prevents players from being confused when they pair the server but it shows up as offline in the app.

The following error message will be visible in your server log if connectivity is not working: Rust+ companion server connectivity test failed! Disabling Rust+ features. Details will be provided in the error message.

To fix this error message you will either need to configure your server so that the test passes or disable Rust+ properly (see above).

Special Pages


Wikis

?

Render Time: 62ms

DB GetPage 50
Generate Html 0
SaveChanges (1) 9
Render Body 0
Render Sidebar 0