Windy/LinuxGSM-Docs
1
0
Fork 0
mirror of https://github.com/GameServerManagers/LinuxGSM-Docs.git synced 2025-01-08 11:57:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

GITBOOK-302: change request with no subject merged in GitBook

Browse Source
This commit is contained in:
Daniel Gibbs 2023-07-26 22:04:38 +00:00 committed by gitbook-bot
parent cbd2466d77
commit e559d939ec
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
6 changed files with 157 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.gitbook/assets/Almalinux-logo-white-v2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 16 KiB

BIN
.gitbook/assets/Rocky_Linux.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

77
commands/README.md
View File

@ -4,48 +4,57 @@ Replace `./gameserver` with the actual script name. Every command has a short ve
## Global commands list
| Command Name | Command | Short |
| :--- | :--- | :--- |
| [Install](install.md) | `./gameserver install` | `./gameserver i` |
| [Auto Install](install.md#auto-install) | `./gameserver auto-install` | `./gameserver ai` |
| [Start](start-stop-restart.md#starting-a-server) | `./gameserver start` | `./gameserver st` |
| [Stop](start-stop-restart.md#stopping-a-server) | `./gameserver stop` | `./gameserver sp` |
| [Restart](start-stop-restart.md#restarting-a-server) | `./gameserver restart` | `./gameserver r` |
| [Details](details.md) | `./gameserver details` | `./gameserver dt` |
| [Post Details](details.md#post-details) | `./gameserver postdetails` | `./gameserver pd` |
| [Backup](backup.md) | `./gameserver backup` | `./gameserver b` |
| [Update LinuxGSM](update-lgsm.md) | `./gameserver update-lgsm` | `./gameserver ul` |
| [Monitor](monitor.md) | `./gameserver monitor` | `./gameserver m` |
| [Test Alert](test-alert.md) | `./gameserver test-alert` | `./gameserver ta` |
| [Update](update.md) | `./gameserver update` | `./gameserver u` |
| [Check Update](check-update.md) | `./gameserver check-update` | `./gameserver cu` |
| [Force Update](force-update.md) | `./gameserver force-update` | `./gameserver fu` |
| [Validate](validate.md) | `./gameserver validate` | `./gameserver v` |
| [Console](console.md) | `./gameserver console` | `./gameserver c` |
| [Debug](debug.md) | `./gameserver debug` | `./gameserver d` |
| Command Name | Command | Short |
| ---------------------------------------------------- | --------------------------- | ----------------- |
| [Install](install.md) | `./gameserver install` | `./gameserver i` |
| [Auto Install](install.md#auto-install) | `./gameserver auto-install` | `./gameserver ai` |
| [Start](start-stop-restart.md#starting-a-server) | `./gameserver start` | `./gameserver st` |
| [Stop](start-stop-restart.md#stopping-a-server) | `./gameserver stop` | `./gameserver sp` |
| [Restart](start-stop-restart.md#restarting-a-server) | `./gameserver restart` | `./gameserver r` |
| [Details](details.md) | `./gameserver details` | `./gameserver dt` |
| [Post Details](details.md#post-details) | `./gameserver postdetails` | `./gameserver pd` |
| [Skeleton](skeleton.md) | `./gameserver skeleton` | `./gameserver sk` |
| [Backup](backup.md) | `./gameserver backup` | `./gameserver b` |
| [Update LinuxGSM](update-lgsm.md) | `./gameserver update-lgsm` | `./gameserver ul` |
| [Monitor](monitor.md) | `./gameserver monitor` | `./gameserver m` |
| [Test Alert](test-alert.md) | `./gameserver test-alert` | `./gameserver ta` |
| [Update](update.md) | `./gameserver update` | `./gameserver u` |
| [Check Update](check-update.md) | `./gameserver check-update` | `./gameserver cu` |
| [Force Update](force-update.md) | `./gameserver force-update` | `./gameserver fu` |
| [Validate](validate.md) | `./gameserver validate` | `./gameserver v` |
| [Console](console.md) | `./gameserver console` | `./gameserver c` |
| [Debug](debug.md) | `./gameserver debug` | `./gameserver d` |
## Specific commands
### Teamspeak server
### Teamspeak 3
| Command Name | Command | Short |
| :--- | :--- | :--- |
| [Change Password](change-password.md) | `./gameserver change-password` | `./gameserver pw` |
| Command Name | Command | Short |
| ------------------------------------- | ----------------------------- | ----------------- |
| [Change Password](change-password.md) | `./ts3server change-password` | `./gameserver pw` |
### Unreal & Unreal 2 Engine Games
| Command Name | Command | Short |
| :--- | :--- | :--- |
| Command Name | Command | Short |
| ----------------------------------- | ----------------------------- | ----------------- |
| [Map Compressor](map-compressor.md) | `./gameserver map-compressor` | `./gameserver mc` |
### Rust 
| Command Name | Command | Short |
| ----------------------------------- | ------------------------ | ----------------- |
| [Full Wipe](./#rust) | `./rustserver full-wipe` | `./rustserver fw` |
| [Map Wipe](../game-servers/rust.md) | `./rustserver map-wipe` | `./rustserver mw` |
## Developer & Debug commands
| Command Name | Command | Short |
| :--- | :--- | :--- |
| [Developer](https://github.com/GameServerManagers/LinuxGSM-Docs/tree/0412348decd8889d020851076f6435bca490a773/developers/developer-commands.md) | `./gameserver developer` | `./gameserver dev` |
| Detect Dependencies | `./gameserver detect-deps` | `./gameserver dd` |
| Detect Glibc | `./gameserver detect-glibc` | `./gameserver dg` |
| Detect ldd | `./gameserver detect-ldd` | `./gameserver dl` |
| Query Raw | `./gameserver query-raw` | `./gameserver qr` |
| Clear Functions | `./gameserver clear-functions` | `./gameserver cf` |
| Command Name | Command | Short |
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | ------------------ |
| [Developer](https://github.com/GameServerManagers/LinuxGSM-Docs/tree/0412348decd8889d020851076f6435bca490a773/developers/developer-commands.md) | `./gameserver developer` | `./gameserver dev` |
| Detect Dependencies | `./gameserver detect-deps` | `./gameserver dd` |
| Detect Glibc | `./gameserver detect-glibc` | `./gameserver dg` |
| Detect ldd | `./gameserver detect-ldd` | `./gameserver dl` |
| Query Raw | `./gameserver query-raw` | `./gameserver qr` |
| Clear Modules | `./gameserver clear-moeuldes` | `./gameserver cm` |

13
commands/check-update.md
View File

@ -1,6 +1,6 @@
# check-update
LinuxGSM comes with a game server `check-update` command. All [SteamCMD](../steamcmd/) games servers are supported.
LinuxGSM comes with a game server `check-update` command. All [SteamCMD](../steamcmd/) games servers are supported, as well as some other servers such as Teamspeak, Minecraft, Mumble & Factorio.
## Commands
@ -8,7 +8,7 @@ Standard: `./gameserver check-update`
Short: `./gameserver cu`
Unlike the [update](update.md) command `check-update` will check for any available update and taking no action if no update is available. If there is an update it will send an alert.
Unlike the [update](update.md) command `check-update` will check for any available updates and take no action if no update is available. If there is an update it will send an alert.
## Automatic check for update
@ -26,21 +26,20 @@ To edit cronjobs, type:
A cronjob can be run as the `gameserver user` or as `root`, this choice is down to personal preference. Remember to amend the examples to match a specific game server.
Here is an example of a user based cronjob to check for an update once an hour.
Here is an example of a user-based cronjob to check for an update once an hour.
```text
```
0 * * * * /home/username/gameserver check-update > /dev/null 2>&1
```
Here is an example of a root based cronjob to check for an update once an hour.
Here is an example of a root-based cronjob to check for an update once an hour.
{% hint style="info" %}
The extra `su - username -c` indicates which user to run the script as.
{% endhint %}
```text
```
0 * * * * su - username -c '/home/username/gameserver update' > /dev/null 2>&1
```
[crontab.guru](https://crontab.guru/) is a great resource to generate cronjobs.

6
commands/install.md
View File

@ -35,7 +35,7 @@ Short: `./gameserver ai`
`chmod +x gameserver`
1. Run the install command: `./gameserver install` or `./gameserver auto-install` to bypass any prompts.
2. Follow on screen instructions.
2. Follow on-screen instructions.
## Install Dependencies
@ -89,13 +89,13 @@ If some files/directories are not owned by the correct user, use the `chown` com
#### Poor Network Connection to Steam servers
If the connection to the Steam servers is poor (quite common), SteamCMD download can fail. This is why LinuxGSM will always ask you if installation was successful allowing admins to retry the download should it fail.
If the connection to the Steam servers is poor (quite common), the SteamCMD download can fail. This is why LinuxGSM will always ask you if the installation was successful allowing admins to retry the download should it fail.
If there are still issues downloading try the [validate](validate.md) option.
`./gameserver validate`
If downloading is still failing it may be worth contacting your server provider to confirm steam servers are not being blocked for any reason.
If downloading is still failing it may be worth contacting your server provider to confirm Steam servers are not being blocked for any reason.
It is also worth searching the internet for issues relating to the error message you receive.

139
linux/distro.md
View File

@ -4,72 +4,143 @@ Picking a distro to run a game server is a personal choice and different admins
LinuxGSM developers primarily use Ubuntu for development and attempt to support the ones listed below. While LinuxGSM developers will attempt to support other distros there is no guarantee everything will work as expected, but should an issue occur, submitting GitHub issues is welcome.
## Ubuntu
## Debian Based Distributions
### Ubuntu
![](../.gitbook/assets/ubuntu\_black-orange\_hex\_su.png)
Ubuntu is a free and open-source Linux distribution based on Debian, and popular with game developers such as Valve. Game developers tend to prefer newer software when developing game servers, as Ubuntu regularly release updates and have an LTS (Long-Term-Support) release every 2 years it is very compatible with game servers. Ubuntu has generally been known to have a large community and get relatively forgiving to newer users. Ubuntu is also the main choice of for the development of LinuxGSM. This means that Ubuntu is the recommended distro for LinuxGSM.
#### **Reasons to use Ubuntu with LinuxGSM:**
It is recommended that only Ubuntu LTS releases are used for game servers because of the longer support life span compared with standard releases (6 months). It is also recommended that the latest LTS is used when installing a server. If a server is currently running on an older LTS and the game server is functioning upgrading is optional.
1. **Stability and Reliability:** Ubuntu is a free and open-source Linux distribution based on Debian. It is renowned for its stability and reliability, making it an excellent choice for hosting game servers. Ubuntu's LTS (Long-Term Support) releases, which are published every two years, offer an extended support lifespan, ensuring that your server remains secure and up-to-date for an extended period.
2. **Game Developer Preference:** Ubuntu has gained popularity among game developers and companies like Valve. This preference is due to Ubuntu's consistent and timely software updates, allowing game developers to work with newer libraries and tools, which is essential for developing and running modern game servers.
3. **Large and Supportive Community:** With a vast user base, Ubuntu boasts an active and helpful community. This large community ensures that you can easily find solutions to issues, access guides, and receive support when setting up or troubleshooting your game server.
4. **User-Friendly Experience:** Ubuntu is known for its user-friendly interface, making it an attractive choice for both experienced Linux users and newcomers. The distribution provides an intuitive environment, simplifying the server setup process for those who might be new to managing game servers.
5. **Preferred Distro for LinuxGSM Development:** Ubuntu is the main choice for the development of LinuxGSM itself. Using Ubuntu ensures that you have the best compatibility and the smoothest experience when running LinuxGSM for managing your game servers.
#### **Recommendations for Ubuntu Usage with LinuxGSM:**
1. **Choose LTS Releases:** It is highly recommended to use Ubuntu LTS releases for hosting game servers. LTS releases offer a longer support lifespan (typically 5 years) compared to standard releases (which have a support period of 6 months). This longer support period means fewer disruptions and security risks for your game server.
2. **Latest LTS Version:** Whenever you install a game server, opt for the latest LTS release available at that time. This ensures that you have access to the latest software and updates, maximizing compatibility and security.
3. **Optional Upgrades:** If your game server is currently running on an older LTS release and is functioning correctly, upgrading to a newer LTS release is optional. However, consider upgrading at an appropriate time to stay current with the latest features and security patches.
{% hint style="info" %}
Ubuntu 18.04 LTS is recommended
Ubuntu 22.04 LTS is recommended
{% endhint %}
| **Version** | **Code name** | **Release date** | **Supported until** |
| ----------------------------------------------------------------------------------------------------------------- | ---------------- | ---------------- | ------------------- |
| [~~16.04 LTS~~](https://en.wikipedia.org/wiki/List\_of\_Ubuntu\_releases#Ubuntu\_16.04\_LTS\_%28Xenial\_Xerus%29) | ~~Xenial Xerus~~ | ~~2016-04-21~~ | ~~2021-04~~ |
| [18.04 LTS](https://en.wikipedia.org/wiki/List\_of\_Ubuntu\_releases#Ubuntu\_18.04\_LTS\_%28Bionic\_Beaver%29) | Bionic Beaver | 2018-04-26 | 2028-04 |
| 20.04 LTS | Focal Fossa | 2020-04-23 | 2025-04 |
| **Version** | **Code name** | **Release date** | **Supported until** |
| -------------------------------------------------------------------------------------------------------------- | --------------- | ---------------- | ------------------- |
| [18.04 LTS](https://en.wikipedia.org/wiki/List\_of\_Ubuntu\_releases#Ubuntu\_18.04\_LTS\_%28Bionic\_Beaver%29) | Bionic Beaver | 2018-04-26 | 2023-04 |
| 20.04 LTS | Focal Fossa | 2020-04-23 | 2025-04 |
| 22.04 LTS | Jammy Jellyfish | 2022-04-21 | 2027-04 |
[https://en.wikipedia.org/wiki/Ubuntu#Releases](https://en.wikipedia.org/wiki/Ubuntu#Releases)
## Debian
### Debian
![](../.gitbook/assets/debian.png)
Debian is another popular distro that sits upstream of Ubuntu that shares many of the same advantages of Ubuntu. The release cycle is every 2 years. Debian supports “backports”, which allows newer software to be installed on stable Debian releases. This is particularly useful for game servers and LinuxGSM that may require newer software.
#### **Reasons to use Debian with LinuxGSM:**
1. **Rock-Solid Stability:** Debian is renowned for its unmatched stability and reliability. As the upstream distribution for Ubuntu, it serves as the foundation for many popular Linux distributions, including Ubuntu itself. For game servers that require a stable and consistent environment, Debian is an excellent choice.
2. **Long Release Cycle:** Debian follows a predictable release cycle, with major stable releases approximately every two years. This extended cycle ensures a robust and mature platform for hosting game servers, minimizing the need for frequent system updates and reconfigurations.
3. **Backports Support:** One of Debian's significant advantages is the availability of "backports." These are newer versions of software packages that can be installed on stable Debian releases. This feature allows you to access the latest software and libraries that might be required for running specific game servers and LinuxGSM.
4. **Wide Package Selection:** Debian boasts a vast repository of software packages, covering a broad range of applications and tools. This extensive selection ensures that you can easily find and install the necessary dependencies and server components to run your game servers smoothly.
5. **Security Focus:** Security is a top priority for Debian's development team. The distribution is known for its prompt security updates and active maintenance, making it a secure choice for hosting game servers and protecting them from potential threats.
#### **Recommendations for Debian Usage with LinuxGSM:**
1. **Stable Releases:** For most game server deployments, it is recommended to use Debian's stable releases. These versions have undergone extensive testing and are well-suited for production environments.
2. **Backports for Newer Software:** If your game server or LinuxGSM requires newer software versions, consider using the backports repository. This way, you can leverage the latest software while still benefiting from Debian's overall stability.
3. **Security Updates:** Regularly apply security updates to keep your Debian server secure and protected from potential vulnerabilities. Debian's robust security team ensures that security patches are promptly released and widely available.
4. **Consider System Requirements:** Before choosing Debian, ensure that your game server's software and any specific tools you intend to use are compatible with the version of Debian you plan to install. Verify system requirements to ensure optimal performance.
{% hint style="info" %}
Debian 10 "Buster" is recommended
Debian 12 "Bookworm" is recommended
{% endhint %}
| **Version** | **Status** | **Code name** | **Release date** | **Security support until** | **LTS until** |
| ----------- | ---------------- | ------------- | -------------------- | -------------------------- | ---------------- |
| ~~8~~ | ~~oldoldstable~~ | ~~Jessie~~ | ~~25–26 April 2015~~ | ~~17 June 2018~~ | ~~30 June 2020~~ |
| 9 | oldstable | Stretch | 17 June 2017 | 2020 | June 2022 |
| 10 | stable | Buster | 6 July 2019 | 2022 | 2024 |
[https://en.wikipedia.org/wiki/Debian\_version\_history](https://en.wikipedia.org/wiki/Debian\_version\_history)
| **Version** | **Status** | **Code name** | **Release date** | **Security support until** | **LTS until** |
| ----------- | ---------------- | ------------- | ---------------- | -------------------------- | ------------- |
| 10 | ~~oldoldstable~~ | Buster | 6 July 2019 | 2022 | 2024 |
| 11 | oldstable | Bullseye | 14 August 2021 | | |
| 12 | stable | Bookworm | 10 June 2023 | | |
[https://en.wikipedia.org/wiki/Debian\_version\_history#Release\_table](https://en.wikipedia.org/wiki/Debian\_version\_history#Release\_table)
## CentOS
## Enterprise Linux Distros
LinuxGSM also works with Enterprise Linux distributions. Known for their stability and long support cycle Enterprise Linux distros are a great choice for Game Servers
### CentOS
![](../.gitbook/assets/centos.png)
CentOS is a Linux distribution that provides a free, enterprise-class, community-supported computing platform functionally compatible with its upstream source, Red Hat Enterprise Linux. This means CentOS is considered a very stable enterprise-grade distro and as such is very popular with server admins. CentOS also has a very long support cycle compared with other distros. The main downside to stability is that the latest software is not always available; this can be an issue when dealing with game servers.
{% hint style="danger" %}
[Significant changes](https://blog.centos.org/2020/12/future-is-centos-stream/) in the future of CentOS has occured.
{% endhint %}
{% hint style="warning" %}
CentOS 6 is not supported by LinuxGSM
{% hint style="info" %}
CentOS is no longer recommended for use with LinuxGSM for hosting game servers.
{% endhint %}
{% hint style="info" %}
CentOS 8 is recommended
Rocky Linux or Alma Linux are now the recommended alternative Enterprise Linux Distro
{% endhint %}
| **CentOS version** | Release date | Full updates | Maintenance updates |
| ------------------ | ----------------- | --------------- | -------------------- |
| ~~6~~ | ~~10 July 2011~~ | ~~10 May 2017~~ | ~~30 November 2020~~ |
| 7 | 7 July 2014 | 6 August 2020 | 30 June 2024 |
| 8 | 24 September 2019 | 1 May 2024 | 31 December 2021 |
| Stream 8 | | | 31 May 2024 |
{% hint style="danger" %}
[Significant changes](https://blog.centos.org/2020/12/future-is-centos-stream/) in the future of CentOS have occurred.
{% endhint %}
#### **Reasons for the Change:**
1. **Shift to CentOS Stream:** CentOS Stream has become the rolling-release development version of RHEL, rather than a downstream clone of RHEL. This change means CentOS Stream might receive more frequent updates, which can introduce unpredictability and potential compatibility issues when managing game servers with LinuxGSM.
2. **Impact on Stability:** CentOS Stream's shift towards being an upstream development platform might lead to reduced stability compared to previous CentOS versions. For hosting game servers, a stable environment is crucial to ensure consistent performance and avoid unnecessary disruptions.
| **CentOS version** | Release date | Full updates | Maintenance updates |
| ------------------ | ---------------- | -------------- | -------------------- |
| ~~6~~ | ~~10 July 2011~~ | ~~2017-05-10~~ | ~~30 November 2020~~ |
| 7 | 2014-07-07 | 2020-08-06 | 30 June 2024 |
| 8 | 2019-09-24 | 2021-12-31 | |
| Stream 8 | 2019-09-24 | 2024-05-31 | |
| Stream 9 | 2021-12-03 | 2027-05-31 | |
### Rocky Linux
<figure><img src="../.gitbook/assets/Rocky_Linux.png" alt=""><figcaption></figcaption></figure>
#### **Reasons to use Rocky Linux with LinuxGSM:**
1. **RHEL Compatibility:** Rocky Linux's binary compatibility with RHEL ensures that LinuxGSM, designed to manage game servers on Linux, will run seamlessly on Rocky Linux. This compatibility guarantees a stable environment for hosting game servers and a familiar experience for users transitioning from CentOS.
2. **Stability and Long-Term Support:** Game servers require a stable and reliable operating system to ensure continuous gameplay for players. Rocky Linux's focus on stability and long-term support makes it an ideal choice for hosting game servers with LinuxGSM.
3. **Community-Driven Development:** LinuxGSM benefits from being community-driven, just like Rocky Linux. This alignment in community-focused development fosters a collaborative environment, where users of both projects can actively contribute and seek support from fellow enthusiasts.
4. **Transparent Security Updates:** Regular security updates and patches in Rocky Linux ensure that your game servers remain secure against potential threats. With LinuxGSM's support for automatic updates, maintaining server security becomes a smoother process.
#### **Ideal Use Cases:**
* Game Server Hosting: Rocky Linux's RHEL compatibility and stability make it an excellent choice for deploying and managing game servers with LinuxGSM.
* Continuity from CentOS: For users previously running game servers on CentOS with LinuxGSM, transitioning to Rocky Linux ensures a familiar and stable environment.
### **Alma Linux**
<figure><img src="../.gitbook/assets/Almalinux-logo-white-v2.png" alt=""><figcaption></figcaption></figure>
#### **Reasons to use Alma Linux with LinuxGSM:**
1. **RHEL Compatibility:** Alma Linux's direct binary compatibility with RHEL ensures that LinuxGSM will run seamlessly on Alma Linux, providing a stable platform for hosting game servers.
2. **Community-Driven Development:** LinuxGSM benefits from being community-driven, just like Rocky Linux. This alignment in community-focused development fosters a collaborative environment, where users of both projects can actively contribute and seek support from fellow enthusiasts.
3. **Long-Term Support and Stability:** Game servers require consistent performance and long-term support to avoid disruptions. Alma Linux's commitment to stability and long-term support aligns with the requirements of managing game servers using LinuxGSM.
4. **Security Emphasis:** Alma Linux prioritizes security, providing timely updates and patches. When combined with LinuxGSM's capabilities for automated updates, you can maintain a secure gaming environment effortlessly.
#### **Ideal Use Cases:**
* CentOS Replacement: For users transitioning from CentOS to Alma Linux for hosting game servers with LinuxGSM, the distribution's RHEL compatibility ensures continuity and stability.
* Enterprise Game Server Deployments: Alma Linux's enterprise-grade stability and long-term support make it well-suited for hosting game servers in professional gaming environments.
### EPEL
LinuxGSM uses packages that are not available by default in CentOS because of this the EPEL (Extra Packages for Enterprise Linux) repository is required to install all dependencies. EPEL is a repository managed by the fedora project to add extra packages to RHEL/CentOS.
LinuxGSM uses packages that are not available by default in CentOS because of this the EPEL (Extra Packages for Enterprise Linux) repository is required to install all dependencies. EPEL is a repository managed by the Fedora project to add extra packages to RHEL/CentOS.
{% hint style="info" %}
EPEL is required to run LinuxGSM