server.description (Rust server ConVar)
How server.description sets the text players see for a Rust server, line breaks with \n, applying it without a restart, and keeping it in server.cfg.
Last updated Verified on Rust build 25582902, 2026-09-28
- Kind
- Variable
- Value on build 25582902
A Rust Server- Server help text
- (Generated) Short description of the server shown to players in the server browser
- Applies
- Immediately (runtime)
- Persists in
- server.cfg
- Vanilla Rust
- Yes, native
- Example
server.description "Weekly wipes on Thursday.\nNo plugins, vanilla rates."
Gotchas
- A line break is written as \n inside the quoted value, not as a real new line in server.cfg.
- Not written to serverauto.cfg by server.writecfg, so keep it in server.cfg.
server.description is the longer text about your server. The server's help text, which Facepunch marks as generated: "Short description of the server shown to players in the server browser". Facepunch's server guide describes it as the text on the server connection window and suggests using it for the size or intent of the server.
Applying a change
It can be set on a running server, with no restart, over RCON or in the server console:
server.description "Weekly wipes on Thursday.\nVanilla rates, no plugins."
The value we read on our test server was A Rust Server, which is Panelra's default, not a Rust default.
Line breaks
server.cfg has one ConVar per line, so a real line break inside the value would end the line. Write a line break as the two characters \n inside the quotes, as in the example above. Panelra converts the new lines you type in the dashboard to \n when it writes server.cfg. When you read the value back over RCON, the escape can come back doubled (\\n), so compare with that in mind if you script checks.
Keeping it after a restart
server.writecfg does not save it; our test server's serverauto.cfg had no server.description line. Keep the text in server.cfg, quoted. Facepunch's guide says server.cfg is read at startup and takes priority over the command line, which is also the easier place to edit a long value than a startup argument.
In Panelra
Description is under Settings and applies instantly over RCON. It is part of the server.cfg Panelra regenerates on every apply and start, so it survives a restart.
Set it in Panelra
Change server.description from the dashboard instead of editing files over SSH.
Related ConVars
- server.hostname(Generated) Server name displayed in the server browser
- server.url(Generated) Server website URL displayed in the server browser; leave empty to show no link
- server.headerimage(Generated) URL of the banner/header image shown at the top of this server's page in the server browser
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.