> ## Documentation Index
> Fetch the complete documentation index at: https://rsg.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 📥 Installation

> RSG Framework Installation Info

## Generate a CFX Key

Creating a license key for your server is easy!
Just head over to [https://keymaster.fivem.net/](https://keymaster.fivem.net/) and click "New server" in the navigation menu.

<Note>
  **Watch the below video of the Installation of a RSG RedM Server via txAdmin**
</Note>

<iframe width="708" height="432" src="https://www.youtube.com/embed/LHjZpzoMqdU" title="RDR2 :  RSG txAdmin RedM Server Setup (2024)" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen />

<Info>
  XAMPP is optional here, you can install [MariaDB](https://native-network.net/downloads/download/895/) by itself! Just remember to configure your [ports](https://zap-hosting.com/guides/docs/en/vserver_windows_port/)!
</Info>

## Install [XAMPP ](https://www.apachefriends.org/download.html)and [HeidiSQL.](https://www.heidisql.com/download.php)

Start XAMPP and start the first two boxes, "Apache" and "MySQL"

![](https://docs.qbcore.org/~gitbook/image?url=https%3A%2F%2F550110915-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FBTxg66Z0GQkOQS46Nzn3%252Fuploads%252FFdEkA8WoBN1x8YIgeEJc%252FzFwKbxO.png%3Falt%3Dmedia%26token%3Da3c03f26-253d-45fe-9f11-9960b74b6b16\&width=768\&dpr=1\&quality=100\&sign=21340354\&sv=1)

## HeidiSQL

* Open HeidiSQL, click the green circle with the plus sign and name it something

<Check>
  The names don't matter, you can name them whatever you want!
</Check>

![](https://github.com/Rexshack-RedM/rsg-docs/blob/main/images/heidi-step.png)

**Press new to create a session**

![](https://github.com/Rexshack-RedM/rsg-docs/blob/main/images/heidi-step2.png)

**Rename this to whatever you'd like and press open**

## Download the CFX Artifacts

1. Go to[ Windows Server Build](https://runtime.fivem.net/artifacts/fivem/build_server_windows/master/) and download the Latest Recommended or Newest it doesn't really matter. (*I would recommend making sure to have* [*WinRAR* ](https://www.rarlab.com/download.htm)*for this*)

2. Open the file that you just downloaded that should be named something with **server.7z**

3. Optionally create a folder in your `C:\` drive

   1. Create folder `C:\SERVER_NAME`

   2. Create folder `C:\SERVER_NAME\Artifacts`

   3. Create folder `C:\SERVER_NAME\Server`

4. Extract from the server.7z everything into the `C:\SERVER_NAME\Artifacts` folder we created

## Starting your new RedM Server&#x20;

1. Find the file called `FXServer.exe` and double click it, this will launch the TXAdmin launcher for you to get started

2. In the Launch you should get your browser opened with TXAdmin asking you to link your account, link and proceed.&#x20;

3. After you completed this you should see a TXAdmin Launch setup page follow the instructions on page for Server Name etc.

4. Once you get to Deployment type you will choose **Remote URL Template**

![](https://rexshack-gaming.gitbook.io/~gitbook/image?url=https%3A%2F%2F2665592327-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FoARzCbcfrWuH2yeCRObk%252Fuploads%252Fue7AA9Cso5GA0UOcyoD9%252FScreenshot%25202023-10-06%2520181455.png%3Falt%3Dmedia%26token%3D6c440d9b-06a7-4a47-ae3b-7850e2f58e18\&width=768\&dpr=1\&quality=100\&sign=5e76852\&sv=1)

5. Enter the following Recipe link : &#x20;

   1. [https://raw.githubusercontent.com/Rexshack-RedM/txAdminRecipe/main/rsgcore.yaml](https://raw.githubusercontent.com/Rexshack-RedM/txAdminRecipe/main/rsgcore.yaml)

6. Click `Change Path` and enter the following file path `C:\SERVER_NAME\Server` and click `Save` then follow on screen instructions to continue

7. You should be in `Recipe Deployer` , review the recipe and click `Next `

8. Now we are almost ready to launch our newly created server, now enter the key you just made on the [Keymaster](https://keymaster.fivem.net/) where it says `License Key` and then select `Run Recipe`&#x20;

9. Congratulations! 🎉 Your Server is now ready, once the Recipe is ready `Click Save & Run Server`

![](https://rexshack-gaming.gitbook.io/~gitbook/image?url=https%3A%2F%2F2665592327-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FoARzCbcfrWuH2yeCRObk%252Fuploads%252F6hO5VaX0Zq2HbNFFqnmA%252FScreenshot%25202023-10-06%2520182728.png%3Falt%3Dmedia%26token%3D3694db22-91d4-493a-b327-711b70e5e04f\&width=768\&dpr=1\&quality=100\&sign=62ceffc0\&sv=1)

<Info>
  Let yarn install all the way through on the initial startup
</Info>

Once this is complete, we recommend visiting [Setting Permissions](https://rsg.mintlify.app/quickstart) to configure your **server.cfg** with any players you'd like to give elevated permissions!