Documentation

Lunix Shield handbook.

Reference material for operators and staff. 12 chapters covering setup, the panel and the API.

Installation guide FAQ

Start here

From zero to a protected server

03 chapters
01

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
02

Installation

Resource layout, server.cfg and ACE permissions.

  • fxmanifest and folder structure
  • config.lua reference
  • ensure lunix-Shield
  • LunixShield.bypass for trusted staff
03

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

Using the panel

Day-to-day tools for operators and staff

07 chapters
04

Dashboard

Live cards, charts and quick actions.

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

Players

Only currently connected players are listed.

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

Rules

The rule engine and its inputs.

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

Trigger protection

Per-event rate limiting.

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

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
09

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
10

Roles & permissions

Platform roles and per-server rooms.

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

Developers

Integration details and problem solving

02 chapters
11

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
12

Troubleshooting

Common issues.

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

Need the installation checklist?

Follow the ten-step guide from download to a server showing ONLINE in the panel.