# Install txAdmin on my FiveM server

{% hint style="info" %}
TXAdmin is the official FiveM interface to install and manage your server (recipe, DB, permissions, resources).
{% endhint %}

### Goal

* Install FiveM from the Oxygenserv dashboard.
* Generate a **CFX key** (Keymaster).
* Finalize the installation in TXAdmin (recipe + DB + `server.cfg`).

{% hint style="info" %}
Need a DB?

* [Create and access its database](/en/dashboard/creer-et-acceder-a-sa-base-de-donnees.md)
  {% endhint %}

{% hint style="warning" %}
Before a major change (recipe, resources, DB), make a file backup:\
[Create a backup and restore it](/en/dashboard/creer-une-sauvegarde-et-la-restaurer-sur-son-serveur.md).
{% endhint %}

### Step-by-step guide

{% stepper %}
{% step %}
**Install FiveM from the dashboard**

On the dashboard, open **Addons**, then click **Install** next to FiveM.

<figure><img src="/files/098d816f2cb71919f79c7fdabec80e09f96204d4" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Generate your CFX key (Portal)**

Open Portal: <https://portal.cfx.re/servers/registration-keys> then log in.

<figure><img src="/files/93c9f3dce5c7dd0148ae393041f1ada5b87d4b48" alt=""><figcaption></figcaption></figure>

Click "**Generate key**", give it a name then click "**Generate**".

<figure><img src="/files/05e46264da8a7db4cd2d99d6cc3265322c778aeb" alt=""><figcaption></figcaption></figure>

Copy the key that was created by clicking the button below.

<figure><img src="/files/fdb6ad805c4ee54ee12c3cd67601920e85d4cbc3" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Add your key in the server settings**

In the **Settings**tab, paste the key into "**FiveM License**" and enable **txAdmin**.

<figure><img src="/files/7bba088821c1afb7957a3e16cd83d32b1d6cb681" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Retrieve the txAdmin PIN and open txAdmin**

After starting your server, go to the **Console** to find the PIN code.

<figure><img src="/files/33a730a886143953f5c9000f02ff1732139178fb" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Open and log in to txAdmin**

Click **txAdmin** next to your server's name.

<figure><img src="/files/0c0eebb3944d4a7fda6e2ab6d3ed4d605cdc0e07" alt=""><figcaption></figcaption></figure>

In txAdmin, enter the **PIN** displayed in the console.

<figure><img src="/files/c9058ac2d99dbddc88abf431cc4be9570748ee8c" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Link your FiveM account to txAdmin**

You must now authorize TXAdmin with FiveM.

<figure><img src="/files/052b83705ecd05bbb2db3b1354b9573f050e1fb0" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Create the TXAdmin admin password**

Choose a long password, without accents. Write it down.

<figure><img src="/files/c080b9e41becd3dec3dbf70a3836803420184dc2" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Choose the server name and the recipe**

Choose a **name** for your server.

<figure><img src="/files/46865fa2a657e1a25283b66d670e02322c029508" alt=""><figcaption></figcaption></figure>

Then select a **recipe** (Popular Recipes → ESX Legacy or QBCore, for example)

<figure><img src="/files/2d92e7042171fc97655d97aa51d44ecc8797671a" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Check the Data Location**

Do not change the suggested folder.

<figure><img src="/files/cc4d02cb9a83f2244ffe667d3f59eff617dc74f7" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Review Recipe (leave default)**

Now you should arrive on a new page; for the first step, please do not touch anything.

<figure><img src="/files/6bb5001957cfaf3e2fb35ad944206b62f1137d86" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Enter your CFX key and database information**

Enter your CFX key obtained in step 2.

<figure><img src="/files/b825a733a8477a313bb59e30b8db95c5d8ea81b1" alt=""><figcaption></figcaption></figure>

Click "Show/Hide Database options (advanced)", then enter your database credentials ([Create and access its database](/en/dashboard/creer-et-acceder-a-sa-base-de-donnees.md)).

<figure><img src="/files/a76f07cc49fe56ee85986d1ff1fe712835a63d00" alt=""><figcaption></figcaption></figure>

Click "Run Recipe".
{% endstep %}

{% step %}
**Configure the `server.cfg`**

You must now configure and modify the server.cfg file to indicate the port that was assigned to your server.

<figure><img src="/files/0f934e2d528c5b982e11698ed9417a7ca3f8920a" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Start the server**

Now you just have to scroll to the bottom of the page and click "Save & Run Server". And that's it! Your server is ready!

<figure><img src="/files/f34bc8e338a13d7d395f78b7278e946ecc94bcbb" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

### Common issues

#### TXAdmin does not show the PIN

* Make sure the server is started.
* Check the console. The PIN is displayed there.

#### DB issue (connection refused)

* Check host/user/password/port.
* Test a phpMyAdmin access: [Create and access its database](/en/dashboard/creer-et-acceder-a-sa-base-de-donnees.md).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.oxygenserv.com/en/gta-v/installer-un-serveur-fivem-avec-txadmin.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
