ApexDocs
Getting started

Installation

Install Apex on your FiveM server step by step.

Before you start#

You need:

  • A licence key (paid plan or free trial) linked to your Discord account on apex-anticheat.com.
  • Access to your server files and server.cfg (FTP, txAdmin or your host's file manager).

See Requirements for recommended server settings.

1. Download the resource#

Open your dashboard. New servers see the setup wizard "Let's connect your server" — click Download Apex resource. Later you can always download the newest version with Download latest resource on the dashboard.

You get ApexAC.zip with:

text
ApexAC/
├── fxmanifest.lua
├── apex.key          <- your personal licence key
├── client/main.lua
├── server/main.lua
└── web/main.html

Why so small?

The zip contains only a tiny loader. The actual anticheat is downloaded into memory every time the resource starts, so it's always up to date and never stored on your disk. See How Apex works.

Keep apex.key private

Your apex.key is your licence. Don't share it, don't commit it to a public Git repository and don't send it in public channels.

2. Install#

  1. Unzip the download.
  2. Put the ApexAC folder in your server's resources folder (any subfolder like [security] works too).
  3. Add this line to your server.cfg:
cfg
ensure ApexAC

Recommended — lets the dashboard start/stop resources and restart the server:

cfg
add_ace resource.ApexAC command allow

3. Start and confirm#

Start or restart your server. In the console you'll see the Apex logo, then:

text
[OK] LICENSE VALID - apex-XXXX********
Status: PROTECTED. Apex is now guarding this server.

Back in the dashboard, the wizard switches from "Waiting for your server to connect…" to "Server found!" with your server IP and name. Click Confirm & use this name.

That's it

Your server is protected with the default detection settings. Next: review your detection settings, add your staff and set up Discord logs.

Using a convar instead of the file#

Prefer keeping the key in server.cfg? Set it as a convar (it overrides apex.key):

cfg
set apex_key "apex-xxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx-..."
ensure ApexAC

Updating#

You never need to reinstall for updates. Apex loads the newest code every time the resource starts. To pick up an update immediately, restart the resource:

text
restart ApexAC