Installation | Asphyxia Docs

Installing Asphyxia takes about five minutes. You’ll need an active license and a MySQL database.

Requirements

Requirement	Notes
An active Asphyxia license	Buy one at asphyxia.dev
FiveM server (any framework)	ESX, QBCore, standalone — Asphyxia doesn’t care
MySQL database	Sharing one with your framework is fine
`oxmysql`	Asphyxia runs its queries through it
`screencapture`	Used for ban screenshots and the admin menu

Create a server on the dashboard

Open your dashboard and add a server. You’ll get three values — a license key, a server ID, and a shared secret. Keep the page open; you’ll paste all three into server.cfg shortly.

Download the resource

Go to Download in the dashboard and grab the latest .zip. Extract it into your resources folder so the path ends in resources/[core]/asphyxia.

Import the database schema

Run sql/schema.sql against your database. It creates the tables Asphyxia uses for players, bans, strikes, admins, logs and fingerprints. Running it a second time is harmless.

Add your settings to server.cfg

server.cfgini

set asphyxia_license       "your-license-key"
set asphyxia_server_id     "your-server-id"
set asphyxia_shared_secret "your-shared-secret"

ensure asphyxia

ensure asphyxia must come after oxmysql and screencapture. Every available setting is listed on Server configuration.

Save your configuration on the dashboard

Asphyxia doesn’t ship with a working config — it downloads one from your dashboard every time it starts. Open Configuration, adjust anything you want, and press Save at least once. Without a saved config the resource will refuse to start.

Restart and check the console

Restart your server. A healthy start looks like this:

[Asphyxia.] › ℹ info    Checking your license…

  Asphyxia Anti-Cheat  v1.0.0
  ─────────────────────────────────
  Server           : Vanilla
  Resource         : asphyxia
  Panel            : https://asphyxia.dev/dashboard

  Your License     : Lifetime
  Expires in       : ∞ Never
  ─────────────────────────────────

[Asphyxia.] › ✔ success Loaded 0 active ban(s) from your database.
[Asphyxia.] › ✔ success Loaded 0 admin(s) from your database.
[Asphyxia.] › ✔ success Configuration loaded from your dashboard.

If you see an error instead, Troubleshooting lists each one and what to do about it.

Make yourself an admin

Join the server, then add yourself on the dashboard’s Admins page. Give yourself openAdminPanel at minimum, then type /asphyxia in-game to open the admin menu.

Confirming it works

Run asphyxia status in your server console. It prints a summary of everything Asphyxia currently knows:

ASPHYXIA STATUS
────────────────────────────────────────────────────────────
  Version           : 1.0.0
  Config loaded     : yes
  Integrity check   : passing
  Debug mode        : off
  Players online    : 12
  Local bans        : 34
  Global bans       : 1892
  Admins            : 4
  Active whitelists : 0
────────────────────────────────────────────────────────────

Updating

Asphyxia checks for updates when it starts and prints a banner with the changelog if one is available. To update, download the new .zip, replace the folder, and restart. Your configuration and database are untouched.