Documentation
Get up and running. Replace placeholders with your actual values.
Getting started
- Add your server — In the dashboard, add a server with a name, RCON host, port, and password. Use the host/port your Rust server or host provides for WebRCON.
- Connect RCON — Click Connect. RustMaxx will establish an outbound WebSocket to your server. No inbound ports on your side.
- Install optional plugin — For live map and some intel features, install our server-side plugin (Oxide/uMod). Upload to your server and configure as below.
- Set permissions — Use the dashboard to assign staff roles and limit who can run which commands. Audit logs track all actions.
Environment variables
For self-hosted RustMaxx, set these (example placeholders):
.env.example
DATABASE_URL=postgresql://user:pass@host:5432/rustmaxx SESSION_SECRET=your-long-random-secret ADMIN_PASSWORD=your-admin-login-password NEXTAUTH_URL=https://your-domain.com
Plugin config (placeholder)
If you use the optional map/intel plugin, configure it on the server. Example structure (replace with real plugin config):
config/rustmaxx.json
{
"api_url": "https://your-rustmaxx-instance.com",
"server_id": "your-server-id",
"features": ["map", "events"]
}Security model
We keep security simple and transparent.
- Stored credentials — RCON credentials are stored encrypted. We never log or expose your RCON password in plain text.
- Signed requests — Where the plugin talks to RustMaxx, we use HMAC or signed tokens so only your server can authenticate.
- Audit logs — Every command run through the dashboard is logged (who, when, what). You can export and review.
- Outbound-only — RustMaxx initiates connections to your game server. You don't need to open ports to the internet.
