LinuxGSM

Command line tool for managing game servers.

Deploying a Marketplace App

The Linode Marketplace allows you to easily deploy software on a Compute Instance using the Cloud Manager. See Get Started with Marketplace Apps for complete steps.

1. Log in to the Cloud Manager and select the Marketplace link from the left navigation menu. This displays the Linode Create page with the Marketplace tab pre-selected.
2. Under the Select App section, select the app you would like to deploy.
3. Complete the form by following the steps and advice within the Creating a Compute Instance guide. Depending on the Marketplace App you selected, there may be additional configuration options available. See the Configuration Options section below for compatible distributions, recommended plans, and any additional configuration options available for this Marketplace App.
4. Click the Create Linode button. Once the Compute Instance has been provisioned and has fully powered on, wait for the software installation to complete. If the instance is powered off or restarted before this time, the software installation will likely fail.
5. To verify that the app has been fully installed, see Get Started with Marketplace Apps > Verify Installation. Once installed, follow the instructions within the Getting Started After Deployment section to access the application and start using it.

To verify that the app has been fully installed, see Get Started with Marketplace Apps > Verify Installation. Once installed, follow the instructions within the Getting Started After Deployment section to access the application and start using it.

Estimated Deployment Time: LinuxGSM should be fully installed within 10-15 minutes after the Compute Instance has finished provisioning.

Deploying a Marketplace App

• Supported distributions: Ubuntu 22.04 LTS
• Suggested plan: All plan types and sizes can be used.

LinuxGSM Options

• Email address (required): Enter the email address to use for generating the SSL certificates.
• Game Server Name: Enter the code for the server you want to install. See the LinuxGSM Server List.

Limited Sudo User

You need to fill out the following fields to automatically create a limited sudo user, with a strong generated password for your new Compute Instance. This account will be assigned to the sudo group, which provides elevated permissions when running commands with the sudo prefix.

• Limited sudo user: Enter your preferred username for the limited user. No Capital Letters, Spaces, or Special Characters
  
  Locating The Generated Sudo Password
  A password is generated for the limited user and stored in a .credentials file in their home directory, along with application specific passwords. This can be viewed by running: cat /home/$USERNAME/.credentials
  
  For best results, add an account SSH key for the Cloud Manager user that is deploying the instance, and select that user as an authorized_user in the API or by selecting that option in the Cloud Manager. Their SSH pubkey will be assigned to both root and the limited user.
• Disable root access over SSH: To block the root user from logging in over SSH, select Yes. You can still switch to the root user once logged in, and you can also log in as root through Lish.
  
  Accessing The Instance Without SSH
  If you disable root access for your deployment and do not provide a valid Account SSH Key assigned to the authorized_user, you will need to login as the root user via the Lish console and run cat /home/$USERNAME/.credentials to view the generated password for the limited user.

Custom Domain (Optional)

If you wish to automatically configure a custom domain, you first need to configure your domain to use Linode’s name servers. This is typically accomplished directly through your registrar. See Use Linode’s Name Servers with Your Domain. Once that is finished, you can fill out the following fields for the Marketplace App:

• Linode API Token: If you wish to use the Linode’s DNS Manager to manage DNS records for your custom domain, create a Linode API Personal Access Token on your account with Read/Write access to Domains. If this is provided along with the subdomain and domain fields (outlined below), the installation attempts to create DNS records via the Linode API. See Get an API Access Token. If you do not provide this field, you need to manually configure your DNS records through your DNS provider and point them to the IP address of the new instance.
• Subdomain: The subdomain you wish to use, such as www for www.example.com.
• Domain: The domain name you wish to use, such as example.com.

Warning: Do not use a double quotation mark character (") within any of the App-specific configuration fields, including user and database password fields. This special character may cause issues during deployment.

Getting Started After Deployment

Obtaining the Admin Password

The password for the sudo user account was automatically generated during the initial install process. To find this password, log in to your Compute Instance through the LISH Console, or with SSH if you provided an Account Key. The credentials are available in the file /home/$USERNAME/.credentials:

cat /home/$USERNAME/.credentials

Sudo Username: $USERNAME
Sudo Password: 0oVSsWmkbGesmtuTlOEgFl7t
LinuxGSM User: linuxgsm
LinuxGSM User Password: nc023n30cal-3kd

The LinuxGSM user is a member of the sudo group.

To complete the server installation process run su linuxgsm && chdir /home/linuxgsm followed by ./$GAMEERVERNAME install.

More Information

Additional information is available from LinuxGSM.

• LinuxGSM
• LinuxGSM Documentation

The LinuxGSM Marketplace App was developed by the Linode team. For support regarding app deployment, contact Linode Support. For support regarding LinuxGSM itself, connect with the community via Discord.