Deploy PaperMC Game Servers

Install Dependencies Using LinuxGSM

LinuxGSM will attempt to install dependencies either by having the pmcserver 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 pmcserver is already installed run ./pmcserver 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 pmcserver

For security best practice, ensure you set a strong password. Random password:

su - pmcserver

2. Download linuxgsm.sh.

curl -Lo linuxgsm.sh https://linuxgsm.sh && chmod +x linuxgsm.sh && bash linuxgsm.sh pmcserver

3. Run the installer following the on-screen instructions.

./pmcserver install

Basic Usage

All Commands

A complete list of commands can be found by typing.

./pmcserver

Below are the most common commands available.

Running

start

./pmcserver start

stop

./pmcserver stop

restart

./pmcserver 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.

./pmcserver 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.

./pmcserver update

Debugging

Details

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

./pmcserver 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.

./pmcserver 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/pmcserver/logs

Backup

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

./pmcserver 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.

./pmcserver 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/pmcserver/pmcserver monitor > /dev/null 2>&1
*/30 * * * * /home/pmcserver/pmcserver update > /dev/null 2>&1
0 0 * * 0 /home/pmcserver/pmcserver 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.