Deploy Minecraft: Java Edition Game Servers

LinuxGSM is the command-line tool for quick, simple deployment and management of Linux dedicated game servers.

Minecraft: Java Edition Logo

Compatibility

Minecraft: Java Edition will run on popular distros as long as the minimum requirements are met.

Install Notes

LinuxGSM installs the vanilla server by default https://minecraft.net/en/download/server. There is currently no method for LinuxGSM to install custom Minecraft servers automatically. Should you wish to install a custom server you will need to manually install the jar file and point LinuxGSM to it.

PaperMC and Waterfall MC Server is also available here:
https://linuxgsm.com/lgsm/pmcserver/
https://linuxgsm.com/lgsm/wmcserver/

Server

For consistant uptime it is recomended you host a server in a data center. If you dont already have a server, you can rent a dedicated or vitual server from one of our sponsored providers, OVHCloud, Linode, Vultr.

If the command-line isnt for your you can use GameServerApp web-based game server management service.

Minimum Recommended Distros

Other Distros

Although not tested, any distro with tmux => 1.6 and JRE => 21 should also be compatible with Minecraft: Java Edition servers.

Install Dependencies Using LinuxGSM

LinuxGSM will attempt to install dependencies either by having the mcserver user account with sudo access or running the installer as root.

user with sudo access

During the installation if the game server user has sudo permissions LinuxGSM will attempt to install any missing dependencies itself.

root user

if mcserver is already installed run ./mcserver install as root and LinuxGSM will automatically install missing dependencies.

Install

From the command-line do the following. Ensuring you have also installed the required dependencies.

1. Create a user and login. 
adduser mcserver
For security best practice, ensure you set a strong password. Random password: 
su - mcserver
2. Download linuxgsm.sh. 
curl -Lo linuxgsm.sh https://linuxgsm.sh && chmod +x linuxgsm.sh && bash linuxgsm.sh mcserver
3. Run the installer following the on-screen instructions. 
./mcserver install

Basic Usage

All Commands

A complete list of commands can be found by typing. 
./mcserver
Below are the most common commands available.

Running

start

./mcserver start

stop

./mcserver stop

restart

./mcserver restart

console

Console allows you to view the live console of a server as it is running and allow you to enter commands; if supported. 
./mcserver console
To exit the console press CTRL+b d. Pressing CTRL+c will terminate the server.

Updating

update

Update checks for any server updates and applies them. The server will update and restart only if required. 
./mcserver update

Debugging

Details

You can get all important and useful details about the server such as passwords, ports, config files etc.

./mcserver details

Debug

Use debug mode to help you if you are having issues with 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.

./mcserver debug

Logs

Server logs are available to monitor and diagnose your server. Script, console and game server (if available) logs are created for the server.

/home/mcserver/logs

Backup

Backup will allow you to create a complete tar bzip2 archive of the whole server.

./mcserver backup

Monitor

LinuxGSM can monitor the game server by checking that the proccess is running and querying it. Should the server go offline LinuxGSM can restart the server and send you an alert. You can use cronjobs to setup monitoring.

./mcserver monitor

Configure LinuxGSM

For details on how to alter LinuxGSM settings visit LinuxGSM Config Files page.

Documentation

For detailed documentation visit the LinuxGSM docs.

Cronjobs

To automate LinuxGSM you can set scheduled tasks using cronjobs, to run any command at any given time. You can edit the crontab using the following.

crontab -e

Below are the recommended cron tasks.

*/5 * * * * /home/mcserver/mcserver monitor > /dev/null 2>&1
*/30 * * * * /home/mcserver/mcserver update > /dev/null 2>&1
0 0 * * 0 /home/mcserver/mcserver update-lgsm > /dev/null 2>&1

Configure LinuxGSM

For details on how to alter LinuxGSM settings visit LinuxGSM Config Files page.

Documentation

For detailed documentation visit the LinuxGSM docs.

Command-line not your thing?

Quickly deploy your Minecraft: Java Edition game server with GameServerApp using just a few clicks.

How to connect with GameServerApp

Connect your LinuxGSM game server via RconConnect or your dedicated root machine via DediConnect.

LinuxGSM Partner

GameServerApp is a LinuxGSM partner offering features complimenting existing LinuxGSM game servers.

Control, monitor, and automate your Minecraft: Java Edition LinuxGSM game servers from any device:

  • Integrate with Discord & Twitch, whitelist forms, etc.
  • See who's playing on your game servers and enforce your rules.
  • Auto-pilot for machines & game servers.
  • Automate activities using schedules, triggers, and achievements.
  • Integrated shop with in-game delivery and no transaction fees.
  • Invite admins to your dashboard and work together with permission-based access.

Add your first 2 LinuxGSM servers for free.
Learn more »