Skip to main content

Getting Started

Getting Started

This guide explains how to start your server and what the important server settings do.

Starting the Server

Start your server from the panel by clicking Start. The server console will display the startup logs.

If this is the first time the server has been started, the startup process may take slightly longer while the server initializes.

Accessing txAdmin

If txAdmin is enabled, the server will automatically start the txAdmin management interface.

You can access it using the txAdmin address shown in the Network tab of your server panel.

http://SERVER_IP:TxAdminPort

txAdmin may take a few seconds to become available after the server starts.

When accessing txAdmin for the first time you will be prompted to create an administrator account and complete the server setup.

Important Server Settings

Your server has several configurable startup settings available in the panel.

FiveM License Key

Your server's CFX license key. This is required for the server to start.
The key is automatically passed to the server during startup.

FXServer Artifact Version

Controls which FXServer artifact build will be used by the server.
The artifact version determines which version of the FiveM server runtime is installed.

Valid values include:

latest – Automatically install the newest available artifact (recommended)
A specific artifact number – Installs that exact server build

Enable txAdmin

Controls whether the server starts with txAdmin enabled.

  • On – Start using txAdmin
  • Off – Start the server directly using the configuration file

Most users should keep txAdmin enabled as it provides the easiest way to manage your server.

txAdmin Port

The port used for the txAdmin web interface.
You normally do not need to change this unless you want to change the port, must be one of your allocated ports.

Git Repository URL

If set, the server will automatically pull files from the specified Git repository every time the server starts.

Any files in the target folder will be overwritten to match the repository.

Local file changes will be discarded when Git deployment is enabled.

Git Branch

The branch that will be used when pulling the repository.

Default: main

Git Target Path

The folder where the repository will be deployed.

Default:

/home/container/nontxserver

Git Username and Git Token

If you are using a private repository, these fields allow the server to authenticate when pulling from Git.

These values are not required when using public repositories.

Server File Locations

The server uses the following folder structure:

/home/container
├── .internal/        (server runtime files)
├── nontxserver/      (server files when not using txAdmin)

Most users will manage their server through txAdmin and will not need to interact with these folders directly.

If the Server Fails to Start

Check the server console for error messages. Startup errors are usually caused by:

  • Invalid server configuration
  • Missing or incorrect license key
  • Errors in resources or scripts
Back to top