Variables

FiveM

FiveM License

FiveM uses a license key to authenticate your server. You can obtain a license key from here. You may use a key from a previous server, but this is not recommended.

When creating the key:

1. Name it something relevant to your server.

2. Check our Discord for the latest IP Address.

3. The server type is VPS, and you should enter AFK Hosting in the server provider field.

Then copy the Key and paste it in the FiveM License field on the panel.

Max Players

The maximum number of players that can join your server.

By default, your server supports up to 48 players at once. To have more playeres you need to join FiveM's Patreon. All server keys (even free keys) include all functionality if your server is set to 10 slots or less.

Server Hostname

The name of your server. This is what will show up in the server list.

FiveM Version

The version of FiveM you want to use.
You must change this to the version you want to use. Find the latest version here. Then right click on the latest version in the list and click "Copy Link".
NEVER CLIK ON THE LATEST RECOMMENDED OR THE LATEST OPTIONAL BUTTONS.
Paste that link in the FiveM Version field on the panel. Lastly remove everything but the numberes.

Example

https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/6645-9f45d7f6bb723304225304c82996bf58db073657/fx.tar.xz

becomes

6645-9f45d7f6bb723304225304c82996bf58db073657

Steam Web Api Key

This is used for Steam authentication. You can get a key from here. If you do not want to use Steam set the field to none.

Enable TxAdmin

If you want to use TxAdmin. Switch on the left and grey means TxAdmin will not be enabled. While the switch on the right and blue means TxAdmin will be enabled. Make sure to set a port for TxAdmin to use. When using TxAdmin, follow this guide to set it up. If you are not using TxAdmin, follow this guide to set up your server.

TxAdmin Port

To use TxAdmin you need to set a port for it to use. To use a port, go to the Network tab and click "Create Allocation". Then you can add a note to the new allocation. This is the port you will use for TxAdmin. Click on the port number and paste it in the TxAdmin Port field on the panel.

Minecraft

Changing the server version

When changing the server version, you must also reinstall the server. To do this, go to the Settings tab, then click Reinstall Server. This will overwrite the current server files with the new server files.

warning

Reinstalling the server may delete some files.

Please, Please, Please make a backup of your server files before reinstalling the server.

Minecraft Version

The version of Java minecraft you want to install. Leaving latest will install the latest recommended version.
You can also install a specific version by typing the version number. You can find the version number on the MCVersions website.

Server Version

The version of Minecraft you want to use. View the Release Changelogs here.

Sponge Version

The version of SpongeVanilla to download and use. You can find the version number on the SpongeVanilla Downloads website.

Paper Build Number

The build number for the paper release. Leave at latest to always get the latest version. Invalid versions will default to latest. You can find the build number on the PaperMC Downloads website.

Forge Build Type

The type of server jar to download from forge.

Forge Version

The full exact version. Ex. 1.15.2-31.2.4. Overrides MC_VERSION and BUILD_TYPE. If it fails to download the server files it will fail to install. You can find the version number on the Forge Downloads website.

Bungeecord Version

The version of Bungeecord to download and use. You can find the version number on the Bungeecord Downloads website.

Java Server Version

The version of Minecraft Java to install. Use "latest" to install the latest version, or use "snapshot" to install the latest snapshot. You can find the version number on the MCVersions website.

Bedrock Version

The version of bedrock. (Ex. 1.7.0.13). Default version is latest. You can find the version number on the Bedrock Server Downloads website.

Bedrock Server Name

The name for the server. This is what will show up in the server list.

Bedrock Gamemode

The default game mode for the server. (Ex. survival, creative, adventure, spectator). Default is survival.

Bedrock Difficulty

The default difficulty for the server. (Ex. peaceful, easy, normal, hard). Default is easy.

Bedrock Allow Cheats

If true, then cheats like commands can be used. Cheats allow players to use commands that can alter the game, such as changing the time of day, teleporting to different locations, or giving items to players. This can be useful for testing, creative building, or managing a server. However, enabling cheats can also affect the gameplay experience and balance, so use this option with caution.

Spigot Version

The version of Spigot to download and use. You can find the version number on the Spigot Downloads website.

Flavor

The type of Minecraft you would like to run on the next start of the server.
The flavors are also known as server types. The available flavors are:

• Java
• Sponge
• Paper
• Forge
• Bungeecord
• Bedrock

Bedrock Server

When using the Bedrock flavor, you must also change the Docker Image to Bedrock instead of Java.

FiveM Discord Bot

Developer Mode

Developer Mode is required to be enabled to copy required IDs

To enable Developer Mode, go to your Discord settings, then go to Advanced, and enable Developer Mode.

Bot Token

The token for the Discord Bot. You can get a token from theDiscord Developer Portal. This bot should not be used by any other program(s) or servicses and should only be used for this application.

Client ID

The Client ID for the Discord Bot. You will also need the Client ID to invite the bot to your server(s). May also be called APPLICATION ID. You can get the ID by going to your bot, under the General Information tab, and clicking Copy under the APPLICATION ID.

Guild/Server ID

The ID of the server you want the bot to be in. You can get the ID by right clicking on the server name and clicking Copy ID.

Database Connection String

Your MYSQL database string. To create one, go to the DATABASES tab, then click NEW DATABASE, give it a name, click the eye icon, and then click the ROTATE PASSWORD button until your password DOES NOT contain any of the following characters:

#, $, ", ', =, @, :, /

When your password does not contain any of these characters, click the JDBC CONNECTION STRING field and then close that panel. Go back to the Startup tab and paste the text into this box, making sure to REMOVE THE "jdbc:" FROM THE STRING so it starts with "mysql://".

Root Username

The default username to the admin user. DO NOT share this with anyone. If you want to give somebody access to the bot, make a user for them in the web interface.

Root Password

The default password to the admin user. DO NOT share this with anyone. If you want to give somebody access to the bot, make a user for them in the web interface.

Branch

If you wish to pull from a cretan branch of the reposotory.

warning

Other branches may not support pterodactyl, it is best to leave on main or leave blank.

SnailyCAD

info

More information on SnailyCAD can be found on their website.

Client URL

The URL/IP to where the CAD is hosted at, see examples below.

tip

In support, this will be called the client.

Valid Examples:

• https://cad.example.com - subdomain
• https://mycad.com - Top level domain
• http://192.168.0.190:3000 - LAN IP-address
• http://83.39.20.30:3000 - WAN IP-address

Invalid Examples:

• localhost - will simply not work.
• cad.example.com - missing https:// or http://.
• http://192.168.x.x:3000 - default URL, will not work.

API URL

The URL/IP to where the API is hosted at, see examples below.

/v1

/v1 should NOT be included in the API URL field.

It will be added automatically by Pterodactyl.

tip

In support, this will be called the API.

Valid Examples:

• https://cad-api.example.com - subdomain
• http://192.168.0.190:8080 - LAN IP-address
• http://83.39.20.30:8080 - WAN IP-address

Invalid Examples:

• https://cad-api.example.com/v1 - includes /v1
• cad-api.example.com - missing https:// or http://.
• localhost - will simply not work.
• http://192.168.x.x:8080 - default URL, will not work.

Client Port

The port where the client should run on. Should be the same as your servers port.

API Port

The port where the API should run on. Must be created in the Network tab. To create a port, go to the Network tab and click Create Allocation This is the port you will use for the API. Click on the port number, then copy and paste it in the API Port field.

Domain

The domain you might be using. (Optional, however, recommended)

warning

You may only set this when using a domain name. This must be the TLD of the domain. (e.g.: example.com or mycommunity.com)

tip

Valid Examples:

• example.com - top level domain
• [blank] - when using an IP address
• example.com:3000 - a port can only be used when using a domain without SSL (https).

Invalid Examples:

• cad.example.com - subdomain cannot be used. must be top level domain
• cad-api.example.com - subdomain cannot be used. must be top level domain
• 192.38.33.29 - an IP is not a domain

Secure Cookies

Only enable when uterly required. (This may not work all the time; work-in-progress.)

Other fields

If you are looking in the .env file, you may see other fields. Please do not touch these as they may break the CAD.

License

Parts of this file are licensed under the MIT license. Some documentation provided by SnailyCAD.

Websites

Content Management System (Read Only)

The Content Management System (CMS) you selected to use for your website.

WordPress (Easiest)

WordPress is a free and open-source content management system (CMS) that allows you to easily create and manage websites. It is the most popular CMS in the world, powering over 40% of all websites on the internet. WordPress is known for its user-friendly interface, flexibility, and a vast library of themes and plugins that let you customize your website to suit your needs.

Joomla (Easy)

Joomla is a free and open-source content management system (CMS) that allows you to create and manage websites when you need more advanced features than WordPress. It is the second most popular CMS in the world, powering over 3% of all websites on the internet. Joomla is known for its flexibility, scalability, and a vast library of extensions that let you customize your website to suit your needs.

Bring Your Own (Technical Skills Required)

Bring Your Own CMS is a feature that allows you to use your own content management system (CMS) on our hosting platform. This means you can install and configure any CMS of your choice, such as Drupal, Magento, or any other CMS you prefer. This gives you the flexibility to use the tools and features you are most comfortable with.

PHP Version

The version of PHP you want to use.

warning

When changing the PHP version, you must also select the correct Docker Image.

The PHP version must match the Docker Image version. If you are using PHP 8.4, you must also select the PHP 8.4 Docker Image.

Enable Cloudflare Tunnel

Enabling Cloudflare Tunnel allows you to use your own domain with your website without having to set up a reverse proxy or configure multiple DNS records. Please note that you must have a Cloudflare account and your domain must be added to Cloudflare for this to work.

Cloudflared Tunnel Token

The token for the Cloudflare Tunnel. MUST ONLY BE THE TOKEN AND NOT THE WHOLE CONNECTION STRING.

tip

Valid Examples:

• [blank] - when not using Cloudflare Tunnel
• eyK1ElUx9iJCCbuOHtMar79nlquW3SwmMLJ5HsTHWRWqy3eDGg64RyMHYg5i67c8dPkci4SYHThvjaXOOK4qQufRIzSyGDebvaVwmVtRzstKzKMVa3EL2eLukMQsi9JvZD8Yv4Vo3vl7ghCelypRxN1aW0PoBOBxi0REMZuqODAyTU8InxfgzOrU - a valid token*

Invalid Examples:

• cloudflared.exe service install eyRHbS0j8EJzffCfZeiv3VxPr4v2tQwsIe5BEqHVxofCto0Ha... - this is a connection string, not a token

* Please note that this is an example token and will not work. You must generate your own token from the Cloudflare dashboard.