LogoLogo
  • Home
  • Getting Started
  • Configuration
    • LinuxGSM Config
    • Game Server Config
    • Start Parameters
    • cronjobs
    • Running on Boot
    • Running Multiple Game Servers
    • IP Address Configuration
    • LinuxGSM Stats
  • Commands
    • install
    • start-stop-restart
    • monitor
    • test-alert
    • console
    • debug
    • update
    • check-update
    • force-update
    • validate
    • update-lgsm
    • backup
    • map-compressor
    • details
    • mods
    • skeleton
    • fastdl
    • change-password
  • Game Servers
    • 7 Days to Die
    • Arma 3
    • ARK: Survival Evolved
    • Call of Duty 4
    • Dont Starve Together
    • Counter-Strike 2
    • Counter-Strike: Global Offensive
    • Factorio
    • Garry's Mod
    • Insurgency: SandStorm
    • Killing Floor 2
    • Minecraft: Java Edition
    • Multi Theft Auto
    • Rust
    • Sven Co-op
    • Trackmania Nations Forever / Trackmania United Forever
    • TeamSpeak 3
    • Unreal Tournament 99
    • Unreal Tournament 2004
    • Unreal Tournament 3
    • Valheim
    • Xonotic
    • The Front [WIP]
  • Networking
    • IP Address
    • Ports
    • Source Engine
  • Alerts
    • Discord
    • Email
    • IFTTT
    • Pushbullet
    • Pushover
    • Rocket.Chat
    • Slack
    • Telegram
  • Dependencies
    • Java
    • tmux
    • jq
    • gamedig
    • glibc
  • Features
    • ANSI Colors
    • Stop Mode
    • Log Management
    • Message Display Time
  • SteamCMD
    • Steam Master Server
    • Game Server Login Token
    • Branch
    • LAN Discovery
    • Workshop
    • Error Codes
  • Linux
    • distro
    • ftp-scp
    • file-ownership
    • firewalls
    • network-interfaces
    • permissions
    • Symlinking and ln command
  • Troubleshooting
  • FAQ
  • Guides
    • Security
    • Make Webserver Case Insensitive
    • Sourcemod and Metamod:Source
  • Other
    • server-migration
    • basic-usage
    • brand
Powered by GitBook
On this page
  • Introduction
  • Installation
  • Available Commands
  • Running your Server
  • Getting Game Server and Hardware Information
  • Configuring a Server
  • LinuxGSM Config
  • Game Config
  • Config Files
  • Start Parameters
  • Updating a Game Server
  • update command
  • validate command
  • Updating LinuxGSM
  • Automating tasks
  • Running on Boot
  • Troubleshooting
  • Logs
  • console command
  • debug command
Edit on GitHub
Export as PDF
  1. Other

basic-usage

Previousserver-migrationNextbrand

Last updated 1 year ago

Introduction

This basic usage of LinuxGSM will help with getting started. For more advanced usage see pages for a specific command.

Note: Generic "gameserver", "gamename" and "username" values are used for this guide; replace these with your own values.

Installation

The full installation guide can be found at . Follow the basic instructions to install a game server.

Available Commands

To see a list of available commands, execute ./gameserver with no argument.

gameserver@game:~$ ./gameserver
Usage: ./gameserver [option]
GameName - Linux Game Server Manager - Version 170110
https://linuxgsm.com/gameserver

Commands
start             st |Start the server.
stop              sp |Stop the server.
restart           r  |Restart the server.
...

A wiki page for every command is available. Basic tasks and commands are detailed below.

Running your Server

./gameserver start
./gameserver stop
./gameserver restart

Getting Game Server and Hardware Information

./gameserver details

Configuring a Server

Configuring a game server requires altering settings in various locations. Configuration is split in two main sections, Linuxgsm configuration and Game configuration.

LinuxGSM Config

LinuxGSM configuration handles settings related to LinuxGSM and game server definitions. For example settings for alerts and backups. Definitions for game server name, location, Steam App ID, start parameters.

LinuxGSM Configs are located in

lgsm/config-lgsm/gameserver

Game Config

Game servers have several methods of configuration. This means configuration will vary depending upon which game server is being setup.

There are two main methods a game server is configured, either with config files or start parameters. Servers can use one or a mixture of these methods.

note: LinuxGSM will also priorities the usage of config files over start parameters.

Config Files

./gameserver details

Sample output:

Config file:   /home/username/serverfiles/gamename/cfg/gamename-server.cfg

You can edit this file with any Linux text editor such as nano or vi.

Start Parameters

To alter them, edit the LinuxGSM config files using vi or nano and edit variables from the ## Server Start Settings section. The #### LinuxGSM Settings #### section allows customising many different settings.

Updating a Game Server

Most game servers receive regular updates the game developers. These servers can be updated automatically using the update feature.

update command

./gameserver update

validate command

./gameserver validate

Updating LinuxGSM

./gameserver update-lgsm

Automating tasks

Running on Boot

Troubleshooting

Logs

Various logs are available. They can help you checking for your server's health and diagnosing issues.

Logs location: log/

console command

./gameserver console

To exit the console press “CTRL+b, then d”.

Note: pressing “CTRL+c” will terminate the server.

debug command

Use debug mode to help you if you are having issues starting the server. Debug allows you to see the output of the server directly to your terminal allowing you to diagnose any problems the server might be having.

./gameserver debug

See for a full list of commands.

To your server, use the following commands:

The command provides information relevant to the game server. Such as location, settings, and many other information.

handles settings related to LinuxGSM

handles settings related to the dedicated server.

For more info, see .

Most servers use a configuration file to alter settings. Whenever possible, LinuxGSM provides an enhanced default config file from .

The command will provide you with the config file location.

LinuxGSM does not provide specific information about altering this configuration file except for some special games showed in "Game Info" section from the . There are many websites that provide documentation and support on configuring your server.

Many game servers require when configuring some settings. Start parameters are command line options appended to server's executable when you start it.

These parameters can be reviewed using the command.

For more info, see .

The command checks if an update is available for the server. The server will update and restart only if required.

For more info, see

For SteamCMD servers only, the command checks the integrity of server files to make sure files are not corrupt and match the remote version. This can be useful if an update fails or the server is frequently crashing.

For more info, see

LinuxGSM is regularly updated with various enhancements and fixes; Because of this the LinxuGSM updater is available. For more info, see .

For more info, see

You can use to automate any LinuxGSM command. Most commonly used are:

Automatically check for updates.

Automatically check for server crash and restart if needed.

Automatically keep LinuxGSM up to date.

Automatically restart the server at a given time.

Automatically update and restart the server.

Automatically backup the server.

For more details, see .

To run a server , using a monitor cronjob is recommended; any server that was online before a machine reboot will be restarted.

For more info, see or .

For more info, see [.

The command allows you to view the live console of a running server and to enter commands (if available). If the game offers a good console output, it could help diagnose issues along with logs.

For more info, see .

For more info, see .

linuxgsm.com
Command List
start-stop-restart
details
config file's
start parameters
LinuxGSM configuration
Game configuration
LinuxGSM Config Files
https://github.com/GameServerManagers/Game-Server-Configs
details
wiki
Start-Parameters
details
Start-Parameters
update
update
validate
validate
update-lgsm
update-lgsm
Cronjobs
update
monitor
update-lgsm
start-stop-restart
force-update
backup
Cronjobs
On-Boot
Logging
console
console
debug
On-Boot
Monitor