Documentation

Lunix Shield handbook

Reference material for operators and staff. The repository also ships docs/architecture.md, docs/api.md and docs/fivem.md.

Getting started

Create an account, obtain a license and connect your first server.

  • · Sign in with Google
  • · Buy or receive a license
  • · Add a server in the panel
  • · Download and install the resource

Installation

Resource layout, server.cfg and ACE permissions.

  • · fxmanifest and folder structure
  • · config.lua reference
  • · ensure prime-shield
  • · PrimeShield.bypass for trusted staff

Licensing

Keys, limits, statuses and grace periods.

  • · PS-XXXX-XXXX-XXXX format
  • · ACTIVE / EXPIRED / SUSPENDED / REVOKED
  • · Server limits per plan
  • · 30 minute offline grace period

Dashboard

Live cards, charts and quick actions.

  • · Players online and protected
  • · Detections, kicks, warns and bans
  • · Server FPS and heartbeat
  • · 24h / 7d / 30d ranges

Players

Only currently connected players are listed.

  • · Health, armor, weapon, vehicle, coords
  • · Trust score
  • · Player profile timeline
  • · Staff notes

Rules

The rule engine and its inputs.

  • · Enable/disable + action per rule
  • · Blacklist / whitelist / max
  • · Cooldown, threshold, min confidence
  • · Reputation filtering modes

Trigger protection

Per-event rate limiting.

  • · Create a rule per event
  • · Max calls per second
  • · ALLOW / LOG / BLOCK / WARN / KICK / BAN
  • · Live event monitor

Freecam & Live View

What is realistic and what is not.

  • · Client heuristics + server position deltas
  • · Live View uses in-game spectate
  • · Screenshot fallback when no staff is in-game
  • · Evidence and replay capture

Bans

PostgreSQL is the single source of truth.

  • · Multi-identifier bans
  • · Connect-time check queries the database
  • · Temporary and permanent bans
  • · Opt-in global ban registry

Roles & permissions

Platform roles and per-server rooms.

  • · OWNER / ADMIN / MODERATOR / SUPPORT / DEVELOPER
  • · Custom roles
  • · Room matrix per staff member
  • · Privilege escalation protection

API

Every endpoint and its authorisation.

  • · Session cookie for panel endpoints
  • · x-ps-server-id + x-ps-server-key for the resource
  • · Rate limits and validation
  • · See docs/api.md in the repository

Troubleshooting

Common issues.

  • · Server stuck on CONNECTING
  • · LICENSE_ERROR status
  • · Detections not appearing
  • · Discord webhook test fails

Need the installation checklist? Open the installation guide.