Documentation
Everything you need to protect your first server in five minutes.
1. Getting started
- Start a free trial or buy a plan on the pricing page.
- Open the link in the welcome email to choose your control panel password.
- Sign in to the control panel from My Account with the Open control panel button.
2. Install the agent
In the control panel open Server List » Add Server. It creates a one-time install token (valid 24 hours) and shows the command. Run it as root on the server:
curl -fsSL https://app.xpguard.org/install.sh | bash -s -- --token XG-XXXX-XXXX-XXXX-XXXX-XXXX
The server appears in the list within a minute. The agent connects out to the control panel over TLS, so no inbound port or firewall change is needed.
3. The control panel
- Overview: threats stopped, attacks blocked and server health across the fleet.
- Server dashboard: scanner logs, firewall, WAF logs, IPDB, CMS threats, mail and process monitor of one server.
- Mass Operations: run scans, update agents or change settings on many servers at once.
- AI Connector: connect your AI assistant to live security data.
- Subscription: your plan, server licences in use and renewal date.
4. cPanel & WHM plugins
On cPanel servers the agent adds WHM » Plugins » xPGuard for root and cPanel » Security » xPGuard for every account, so your customers can scan and clean their own files and see WAF logs of their own sites.
5. Command line (xgcli)
xgcli status # protection overview
xgcli scan --path /home/user/public_html # scan a folder
xgcli logs --status quarantined # detections
xgcli ip --allow 203.0.113.10 --reason office
xgcli fw --deny-country CN,RU
6. Uninstall
curl -fsSL https://app.xpguard.org/uninstall.sh | bash
The uninstaller removes exactly what the installer added and prints a report.
7. Server licences
Your plan sets how many servers you can connect. When all are in use, the control panel does not create new install tokens and shows a Buy more servers button. Added servers are charged pro rata until your current period ends. When a subscription expires, existing servers stay protected but new servers cannot be added until you renew.