fivem license Required to start the service. Get your keys at https://portal.cfx.re/ | FIVEM_LICENSE | none | required|string|max:33 |
Max Players Set the fivem max play count | MAX_PLAYERS | 48 | required|integer|between:1,48 |
Server Hostname The name that shows up in the server browser | SERVER_HOSTNAME | My new FXServer! | required|string |
fivem version The fivem version that is to be installed. Invalid versions will default to recommended.
An example is `6013-d8ae399d15680da569022f57ab7f2474d307c821`
You can get the latest version from here - https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/ | FIVEM_VERSION | recommended | required|string|max:50 |
Download Link This is the link to download fivem from. This is only used in the install script.
The file you link to needs to be an fx.tar.zx file.
Example:
https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/6013-d8ae399d15680da569022f57ab7f2474d307c821/fx.tar.xz | DOWNLOAD_URL | none | string|nullable |
Steam Web Api Key Use your Steam WebApiKey or set to 'none'. Get your key at https://steamcommunity.com/dev/apikey/ | STEAM_WEBAPIKEY | none | required|string |
txAdmin Port The port for the txAdmin panel | TXHOST_TXA_PORT | 40120 | required|string|max:20 |
Enable txadmin Enables txadmin.
set to 1 to enable. (default is 0 for false) | TXADMIN_ENABLE | 0 | required|boolean |
Game Name Restricts to only running either FiveM or RedM servers.
The setup page will only show recipes for the game specified below !
Options are : fivem or redm | TXHOST_GAME_NAME | fivem | required|in:fivem,redm |
Game type Value to be used : gta5 for FiveM and rdr3 for RedM
! Dont fill in any value it reads the game name variable and set the correct value for it ! | GAME_TYPE | none | string|nullable |
TXHOST DATA PATH Location for TX Admin | TXHOST_DATA_PATH | /home/container/txData | required|string |