search

egeexyz / gsd-cli.rb

A handy CLI for deploying & managing game server as daemons
MIT License
1 stars 1 forks source link

readme

gsd-cli CircleCI

Maintainability Discord

gsd-cli is a convenient CLI tool for automating the installation of dedicated game servers as systemd units (daemons).

gsd-cli is built on systemd and makes use of many Linux-specific commands. As such, gsd-cli is only supported on Linux at this time.

Installation

gsd-cli is designed to be installed as a Ruby Gem Gem Version and executed from the terminal like any CLI application. Install gsd-cli on your favorite Linux machine with the following command: gem install gsd-cli

Usage

Root Required

gsd-cli is currently designed to be run as root.

Dedicated game servers are installed to /opt/ by default (which requires elevated permissions on most distros) and installing new systemd units also requires elevated permissions.

This pattern is handy for LXD containers or dedicated server hosts in Cloud environments. This pattern is not practical for general or home-server use and will be fixed in the future.

Getting Started

The target deployment environment for dedicated servers installed with gsd-cli are LXD containers or Cloud server hosts, such as AWS EC2s or Linode instances.

Dedicated servers are installed to /opt/ by default. So installing a minecraft server will result in a new folder at /opt/minecraft and a new systemd unit file at /etc/systemd/system/minecraft.service.

You manage the configuration for game servers like you would normally. You shouldn't need to modify the .service file.

Usage examples:

gsd-cli install minecraft - will install a Spigot Minecraft server.

gsd-cli update gmod - will update a Garry's Mod server installed with gsd-cli.

Supported Games: