> For the complete documentation index, see [llms.txt](https://docs.oxygenserv.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.oxygenserv.com/en/gta-v/installer-un-serveur-fivem-avec-txadmin.md).

# Install txAdmin on my FiveM server

Step-by-step guide to install txAdmin on your FiveM server (CFX key, database, server.cfg).

{% 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="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-deb9240ea8d18069f0b90d44fd2f6fe36b3ac841%2Fimage_32.png?alt=media" 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="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-392ee71a50196139a7923bf9bba9a46b8721bda5%2Fimage_33.png?alt=media" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-8607a141668d9b830405e1cc1ee4a50217030b3a%2Fimage_41.png?alt=media" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-230e3955b8d1d6551d6f4c50b81fda1139e8383f%2Fimage_42.png?alt=media" 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="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-05b31ef18ad680ac9d1c9080057ab605727f4de7%2Fimage_43.png?alt=media" 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="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-268c1010025c217c6118eb04dd0a7842976529be%2Fimage_44.png?alt=media" alt=""><figcaption></figcaption></figure>
{% endstep %}

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

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

<figure><img src="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-7d1baee2791877f334b88ddb5e7ed1d70fb64dc6%2Fimage_45.png?alt=media" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-11f1781eb2914b8b0b5c4901aeabd1782c463b68%2Fimage_46.png?alt=media" alt=""><figcaption></figcaption></figure>
{% endstep %}

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

You must now authorize TXAdmin with FiveM.

<figure><img src="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-32eb1d7ab2ca622641c0bbfb19e8a4bcb4248ece%2Fimage_48.png?alt=media" alt=""><figcaption></figcaption></figure>
{% endstep %}

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

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

<figure><img src="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-4597ac82c755de07360f617fd9460f3ebe8b9d83%2Fimage_60.png?alt=media" alt=""><figcaption></figcaption></figure>
{% endstep %}

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

Choose a **name** for your server.

<figure><img src="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-996072f0110385978e0c586d173f1bc2ad39368f%2Fimage_62.png?alt=media" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-0c8f131004c09a6c1faf096734d2f5379283df2c%2Fimage_73.png?alt=media" alt=""><figcaption></figcaption></figure>
{% endstep %}

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

Do not change the suggested folder.

<figure><img src="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-667c4adcfecfed184db0f4c56486edda386f05d5%2Fimage_74.png?alt=media" 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="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-cc864457f3fc540234e8b135d35d74b9434d2c72%2Fimage_75.png?alt=media" alt=""><figcaption></figcaption></figure>
{% endstep %}

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

Enter your CFX key obtained in step 2.

<figure><img src="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-87262eb0e6f9fdfc63f72450b9b75533a7747868%2Fimage_76.png?alt=media" 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="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-a2608748a6d526ecb59b213ed267c0a7efe178b8%2Fimage_77.png?alt=media" 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="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-2a71be3d9220a6f434353193b4687d3c814395eb%2Fimage_78.png?alt=media" 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="https://2305008112-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ftkl0lsnxYxJPTz5fY4IW%2Fuploads%2Fgit-blob-eff289157d77a2db3c7ed4796ad5c878ae84eeb5%2Fimage_79.png?alt=media" 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).