Skip to main content
Templates are pre-installed game server configurations that serve as blueprints for quickly deploying new game servers. Instead of installing game files for each server individually, templates allow you to install once and deploy multiple times.

​
Understanding Templates

A template is a complete game server installation stored on a network server. When users create a new game server, GamePanelX copies files from the template, significantly reducing deployment time.
Templates must be created on each network server where you want to deploy game servers of that type.

​
Template Listing

The Templates page displays all templates for a specific game:
ColumnDescription
GameGame name for this template
Date AddedTemplate creation date (MM/DD/YYYY)
DefaultWhether this is the default template for the game
StatusCurrent installation status
DescriptionUser-provided description
ManageEdit or delete the template

​
Template Status

Complete

Template is ready for use

Installing

Template installation in progress

Steam Running

SteamCMD installation in progress

Failed

Template installation failed
The template status automatically updates every 5 seconds via AJAX polling while templates are being installed.

​
Creating Templates

There are three methods for creating templates:

​
Method 1: Steam Installation (Automatic)

For games configured with Steam support:
1

Click Create Template

Click the “Create Template” button on the Templates page.
2

Select Network Server

Choose the network server where the template will be installed.
3

Configure Settings

  • Description: Enter a descriptive name
  • Set as Default: Check to make this the default template
  • Installation Method: Steam installation is automatic
4

Start Installation

Click “Create” to begin the Steam installation process.
GamePanelX supports two Steam installation methods:
  • hldsupdatetool: Legacy Steam installer (method 1)
  • SteamCMD: Modern Steam installer (method 2, recommended)
Steam installations run in a background screen session labeled gpxauto_[template_id]. You can attach to monitor progress:
screen -r gpxauto_24

​
Method 2: Automatic Installation

For games with installation mirrors and commands configured:
1

Initiate Creation

Click “Create Template” and select the target network server.
2

Automatic Process

GamePanelX executes the configured installation commands:
  • Downloads game files from mirrors
  • Extracts archives
  • Runs setup commands
  • Configures permissions
3

Monitor Progress

Watch the status indicator for installation progress.
The installation process uses the AutoInstall command: 
AutoInstall -m "[mirrors]" -c "[install_cmd]" -i [template_id] -C "[callback_url]"

​
Method 3: Manual Archive Upload

For games requiring manual installation:
1

Prepare Game Files

Upload a complete game server installation to your network server:
# Example: Upload via SCP
scp -r gamefiles/ user@server:/home/gameservers/upload/
2

Create Template from Path

In the template creation form:
  • Enter the full path to the uploaded files
  • Add a description
  • Set as default if desired
3

Archive and Install

GamePanelX creates an archive of the files using the CreateTemplate command:
CreateTemplate -p "[file_path]" -i [template_id] -u "[callback_url]"
Ensure uploaded game files have correct permissions (typically 755 for directories, 644 for files, 755 for executables).

​
Template Installation Process

When a template is created, GamePanelX follows this workflow:
  1. Database Entry: Creates a template record with status running or steam_running
  2. Remote Command: Sends installation command to the network server
  3. Installation Execution: Network server executes the installation in a screen session
  4. Callback: Upon completion, the remote server calls back to update status
  5. Status Update: Template status changes to complete or failed

​
Callback System

The remote server communicates installation status via HTTP callbacks to: 
http://your-master-server/includes/callback.php?token=[token]&id=[template_id]
The callback token is randomly generated for security and validated against the database before accepting status updates.

​
Managing Existing Templates

Click any template to access management options:

​
Edit Template

  • Update description
  • Change default status
  • View installation details

​
Delete Template

Deleting a template:
  1. Removes the database entry
  2. Executes the DeleteTemplate command on the remote server
  3. Removes template files from the network server
DeleteTemplate -i [template_id]
Deleting a template does NOT affect existing game servers created from that template. However, new servers cannot be created until a replacement template is installed.

​
Default Templates

Each game can have one default template per network server. When users create a new game server, the default template is automatically selected. To change the default template:
  1. Edit the template you want to set as default
  2. Check “Set as Default”
  3. Save changes
Setting a new default automatically removes the default flag from the previous default template.

​
Template Storage

Templates are stored on network servers in the GamePanelX templates directory: 
/home/[gpx-user]/templates/[template_id]/
Each template is archived as: 
/home/[gpx-user]/templates/template_[template_id].tar.gz

​
Troubleshooting Templates

​
Template Stuck in “Installing” Status

  1. SSH to the network server
  2. Check for running screen sessions: 
    screen -ls
  3. Attach to the installation screen: 
    screen -r gpxauto_[template_id]
  4. Review installation output for errors

​
Template Installation Failed

1

Check Installation Logs

Review the installation output on the network server.
2

Verify Prerequisites

  • Sufficient disk space
  • Required libraries installed
  • Correct permissions
3

Check Network Connectivity

  • Download mirrors accessible
  • Firewall rules allow downloads
4

Retry Installation

Delete the failed template and create a new one.

​
Steam Installation Issues

For Steam-related problems:
  1. Verify Steam credentials in System Settings
  2. Check Steam Guard authentication code
  3. Ensure SteamCMD is installed on the network server
  4. Review Steam installation logs
Steam installations may require interactive authentication the first time. You may need to SSH to the server and complete the Steam Guard challenge manually.

​
Template Best Practices

Use Descriptive Names

Include version numbers or configuration details in template descriptions (e.g., “CS:GO - Updated 2026-03”)

Test Before Defaulting

Create a test server from new templates before setting them as default

Keep Templates Updated

Regularly create new templates when games receive major updates

Multiple Templates

Maintain multiple templates with different configurations (vanilla, modded, competitive)

​
Next Steps

Build docs developers (and LLMs) love

Get started for freeTalk to us