Getting started with your RedM server
Add your Cfx.re license key, set the name and slots on Startup, add resources in server.cfg, join with F8, and create a database for VORP or RSGCore.
This guide gets your RedM (Red Dead Redemption 2 roleplay) server online: the license key, the settings on Startup, server.cfg and the resources folder, joining, a database for frameworks like VORP or RSGCore, and what to know about txAdmin.
Step 1: Add your license key
RedM uses the same free Cfx.re license key as FiveM. Sign in at keymaster.fivem.net, create a server key and copy it.
You can paste it in two places:
- MySQL Setup in the sidebar (under FiveM): paste it into License key and click Save.
- Startup: paste it into fivem license and click Save Changes.
Both save the same setting. The server won't start without a key.
Step 2: Check the other Startup settings
Open the Startup tab. These settings are written into your server every time it starts.
| Setting | What it does |
|---|---|
| fivem license | Your Cfx.re license key (see step 1). |
| Server Hostname | The name in the server list. It is written to sv_hostname in server.cfg on every start. |
| Max Players | Player slots, 1 to 48. Written to sv_maxclients on every start. |
| Steam Web Api Key | Only needed for scripts that use Steam sign-in. Leave it as none otherwise. |
| fivem version | The server build to install, recommended by default. |
| Game Name | Keep this on redm. It decides whether the server runs RedM or FiveM. |
| Enable txadmin | Keep this on 0. See "About txAdmin" below. |
Click Save Changes and restart the server. Because Server Hostname and Max Players are written into server.cfg on each start, change them here, not in the file.
Step 3: server.cfg and resources
Open Files, then File Manager. Your server keeps everything at the top level:
| Path | What it is |
|---|---|
server.cfg |
The main config. It lists which resources start (ensure ... lines), the admin permissions (add_ace and add_principal), tags, locale and project name. It also has set gamename "rdr3", which must stay. |
resources/ |
Your resources (scripts, maps, frameworks). Folders in square brackets, such as [gameplay], are just groups. |
logs/ |
Server logs. |
To add a resource:
- Upload its folder into
resources/. Use Actions, then Upload Folder…, or upload a zip with Upload File… and right-click it, then Decompress. For big uploads, use SFTP (it has its own password, see Using the file manager and SFTP). - Add a line
ensure <resource name>toserver.cfg. Resources that depend on others (for example a database library) must come after them. - Restart the server and check the Console for errors.
The endpoint lines at the top of server.cfg (endpoint_add_tcp and endpoint_add_udp) are set to your server's port automatically on every start, so you don't need to edit them.
Step 4: Start and join
Click Start and watch the Console. The first start can take a minute while resources load.
Your address is on the Overview tab, for example 123.45.67.89:12345. RedM runs on your server's own port, so always use the port shown there.
To join, open RedM, press F8 to open the console and type:
connect 123.45.67.89:12345
When the server is listed, players can also find it by its Server Hostname in the RedM server list. Want an easier address? See Subdomains, ports and dedicated IPs.
Step 5: A database (VORP, RSGCore and others)
Most RedM frameworks need a MySQL database. The MySQL Setup tab creates one for you:
- Click Create MariaDB server. Your plan is split into your RedM server and a small MariaDB server, at no extra cost.
- Click Provision database user. You get a user and a database called
fivem_db, with Host, Port, Database name, Username and Password to copy. - Click Rescan, then Apply connection string. This writes the
set mysql_connection_string ...line into yourserver.cfg. - Restart the server so your database resource (for example
oxmysql) connects.
The tab is shared with FiveM, so some text mentions FiveM. The steps are the same; see Setting up MySQL for your FiveM server for every screen in detail.
About txAdmin
txAdmin is off on our RedM servers: Enable txadmin is 0 and the server starts straight from server.cfg. txAdmin needs its own web port, and that port isn't one of your server's ports, so you can't reach it from outside. Leave Enable txadmin on 0: with it on, the server stops loading server.cfg.
Manage your server through server.cfg, the Console and your framework's admin tools instead. If you'd like txAdmin on your RedM server, open a support ticket and we'll look at it with you.
Admins
The default server.cfg gives the group.admin group all commands. To make yourself an admin, add a line with your own identifier, for example:
add_principal identifier.fivem:1234567 group.admin
Use your own Cfx.re account number (or another identifier your framework uses), then restart. Many frameworks have their own admin setup on top of this; follow their guide.
Common issues
| What you see | What to do |
|---|---|
| The server stops right after starting | Check that fivem license is set. Read the last lines in the Console for the reason. |
| A resource doesn't load | Check the folder name matches the ensure line exactly, and that resources it needs are started before it. |
Your hostname or slot change in server.cfg is undone |
Server Hostname and Max Players on Startup overwrite them on every start. Change them there. |
| Players can't connect | Use the address and port from Overview, not a default port from a tutorial. |
| Scripts can't reach the database | Check the MariaDB server is running, then Apply connection string again on MySQL Setup and restart. |
If you're stuck, open a support ticket with your server name and the last lines of the console, and we'll help.