Check this list before you install. Most problems people report on Discord come from one of these points.
Server#
| Requirement | Details |
|---|---|
| FiveM server | A current server build (artifact). Windows and Linux are both supported. Old builds can lack features AstroShield uses, such as the console listener for the live console. |
| OneSync | Required. Entity, explosion, teleport and many other checks read server-side entity data that only exists with OneSync enabled. |
server.cfg access | You must be able to add two permission lines (see Installation). If your host does not let you edit server.cfg, ask them to add the lines for you. |
| File write access | The server process must be able to write to the resources folder. AstroShield edits the fxmanifest.lua of your other resources and replaces its own files when it updates. |
| Resource name | The folder must be named exactly AstroShield. The permission lines and the shared script entry both use that name. |
Network#
AstroShield opens its connections from your server, so you do not need to open any inbound port for it.
| Direction | Destination | Used for |
|---|---|---|
| Outbound | The AstroShield backend over a WebSocket (TCP) | License check, configuration, bans, dashboard actions. See troubleshooting if your host blocks it. |
| Outbound | https://astroshield.dev over HTTPS | Checking for and downloading updates. |
Use a stable public IP
Your license is locked to the public IP the backend sees when your server connects. If your host rotates that IP, or the server sits behind a NAT or proxy with more than one outbound address, the license will start to fail with IP Locked. Use a server with a fixed outbound IP.
Accounts and license#
- A Discord account to sign in to the dashboard. See Account and security.
- A license. One license protects one server. See Plans and pricing and Buying and redeeming.
Optional integrations#
None of these are required. AstroShield works on a server with no framework at all.
- Frameworks: ESX, QBCore, Qbox and ox_core are detected, which adds health, armor, hunger, thirst, job, money and inventory to the dashboard's player view. See Frameworks.
- txAdmin: admins can be excluded from detections. See Permissions and whitelisting.
- Discord webhooks: ban, connect and disconnect logs. See Configuration.