Rust Wiki

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 app.port TCP port accessible over the internet. Port forward, open it, add firewall rules for it.

The default port is the game port + 68, or the RCon port + 68, whichever is the larger number. If you haven't changed any ports that means it will be 28083. This port must be 10000 or greater for Rust+ to connect to it.

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 its 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 this tool (note: must not be HTTPS!) to test connections to the companion server. Simply type in the IP address and port that the app connects to into the "Location" field. For example: ws://99.99.99.99:28082. Press the "Connect" button and you'll see the results in the log to the right.

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. 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.

Page Links


Special Pages


Wikis

?

Render Time: 63ms

DB GetPage 49
Generate Html 0
SaveChanges (1) 10
Render Body 0
Render Sidebar 1