Revision Difference
rust-companion-server#526907
<cat>Play.Hosting</cat>
<title>Rust+ Server</title>
# 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⤶
# Making it work⤶
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 + 67, or the RCon port + 67, whichever is the bigger. If you haven't changed any ports that means it will be 28082.
⤶
# The "companion.id" File⤶
The default port is the game port + 67, or the RCon port + 67, whichever is the larger number. If you haven't changed any ports that means it will be 28082.
⤶
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.⤶
⤶
# 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.
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!
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.