> For the complete documentation index, see [llms.txt](https://jiffyjrdevelopment.gitbook.io/jiffyjrdevelopmentdocs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jiffyjrdevelopment.gitbook.io/jiffyjrdevelopmentdocs/jiffy-jr-development-docs/jiffy-admin-menu/installation.md).

# Installation

### Requirements

Before installing, make sure the following are running on your server:

* [ox\_lib](https://github.com/overextended/ox_lib) — required for callbacks, UI, and utilities
* [oxmysql](https://github.com/overextended/oxmysql) — required for database logging and punishment history
* FiveM server artifact **4500+** recommended
* **Lua 5.4** enabled (the resource sets this automatically via `fxmanifest.lua`)

***

### Step 1 — Add the Resource

Drag the `jiffy-admin` folder into your resources directory. It can go anywhere, but a dedicated `[JiffyJrDev]` folder keeps things organized:

```
resources/
└── [JiffyJrDev]/
    └── jiffy-admin/
```

***

### Step 2 — Import the SQL

Run the included SQL file against your database before starting the server. This creates the tables for bans, warnings, kicks, and audit logs.

**File:** `jiffy-admin/sql/jiffy_admin.sql`

You can import it via:

* **HeidiSQL** → File → Run SQL File
* **phpMyAdmin** → Import tab
* Command line: `mysql -u root -p your_database < jiffy_admin.sql`

***

### Step 3 — Add to server.cfg

Add the ensure line **after** ox\_lib and oxmysql:

```
ensure ox_lib
ensure oxmysql
ensure jiffy-admin
```

***

### Step 4 — Grant Yourself Owner Rank

The Owner rank is ACE-only and must be granted in `server.cfg`. Find your Rockstar license identifier and add:

```
add_ace identifier.license:YOUR_LICENSE_HERE jiffyadmin.owner allow # Your Name
```

> **How to find your license:** Join the server, open F8 console, and type `status`. Your identifiers are listed next to your name. Copy the one starting with `license:`.

For other staff, see the **Permissions & Ranks** page — Owner is the only rank that requires a manual ACE entry. All other ranks can be granted via framework groups.

***

### Step 5 — Configure (Optional)

Open `jiffy-admin/config.lua` to adjust settings before first launch. The defaults work out of the box, but you may want to review:

* `Config.MenuCommands` — the chat commands that open the menu (default: `/admin`, `/jadmin`)
* `Config.OpenKey` — optional keybind (default: `F10`)
* `Config.Permissions.ranks` — which framework groups map to which rank
* `Config.Logging` — enable/disable database logging, console output, webhooks

{% hint style="info" %}
For webhook setup see the **Configuration** page.
{% endhint %}

***

#### Verify It's Working

1. Restart your server
2. Join in-game
3. Type `/admin` in chat or press `F10`
4. The menu should open — your rank will display in the top-right corner

If the menu doesn't open, check the server console for any `[jiffy-admin]` errors and refer to **Troubleshooting & FAQs**.