[PR #4296] [MERGED] feat: tmux uniqueness #4296

Closed
opened 2026-02-27 04:54:36 +03:00 by kerem · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/GameServerManagers/LinuxGSM/pull/4296
Author: @dgibbs64
Created: 8/27/2023
Status: Merged
Merged: 8/28/2023
Merged by: @dgibbs64

Base: developHead: feature/tmux-uniqueness


📝 Commits (10+)

  • 9c3ac62 refactor: refactor tmux session handling
  • c0bd66d feat: stop server when generating uid
  • 0e8e1a3 refactor: lockfile handling
  • e871833 refactor: improve backup and update monitoring
  • 2cbfb5f refactor: improve logging in core_exit.sh
  • 46d73f0 refactor: improve code readability and remove redundant code
  • 3d6c92b feat: add exitbypass flag to prevent lingering tmux sessions
  • d5a5639 refactor: Refactor lockfile names for consistency and clarity
  • b4c6a2a refactor: refactor check_last_update.sh, command_backup.sh, command_debug.sh, command_mods_remove.sh, command_monitor.sh, command_start.sh, command_stop.sh, command_ts3_server_pass.sh and core_steamcmd.sh
  • 0c716de refactor: update lock file path in core_steamcmd.sh

📊 Changes

31 files changed (+328 additions, -152 deletions)

View changed files

📝 lgsm/modules/check_last_update.sh (+7 -7)
📝 lgsm/modules/check_status.sh (+1 -1)
📝 lgsm/modules/command_backup.sh (+20 -8)
📝 lgsm/modules/command_console.sh (+1 -1)
📝 lgsm/modules/command_debug.sh (+6 -6)
📝 lgsm/modules/command_mods_remove.sh (+1 -1)
📝 lgsm/modules/command_monitor.sh (+148 -47)
📝 lgsm/modules/command_restart.sh (+1 -1)
📝 lgsm/modules/command_send.sh (+1 -1)
📝 lgsm/modules/command_skeleton.sh (+3 -0)
📝 lgsm/modules/command_start.sh (+48 -51)
📝 lgsm/modules/command_stop.sh (+21 -9)
📝 lgsm/modules/command_ts3_server_pass.sh (+2 -2)
📝 lgsm/modules/command_update.sh (+3 -0)
📝 lgsm/modules/command_validate.sh (+4 -1)
📝 lgsm/modules/core_exit.sh (+1 -1)
📝 lgsm/modules/core_steamcmd.sh (+4 -1)
📝 lgsm/modules/fix_csgo.sh (+1 -1)
📝 lgsm/modules/fix_ts3.sh (+13 -0)
📝 lgsm/modules/info_distro.sh (+1 -1)

...and 11 more files

📄 Description

Description

Refactor and improvements of tmux uniqueness, lock file handling and monitoring

  • Renaming lock files to new naming convention
    • Lock files for starting and stopping
    • Lock file for started
    • Lock file for backup
    • Lock file for monitoring
    • Lock file for updating
    • Lock file for last started
    • Lock file for last update
  • LinuxGSM now uses tmux socket name and a session name
  • Improved checks to prevent monitor from running when:
    • installer is running
    • backup is running
    • debug is running
    • server is stopping or starting
    • server is updating (but not when checking for updates)
  • monitor will reboot source engine servers if it detects the "request restart" message in the console
  • deprecate fn_start_teamspeak3

Fixes #2646

note this PR will force a game server to reboot to correct new session names via monitor command.

Tmux uniqueness changes
A socket is a pseudo-file that represents a network connection. Tmux creates a socket file to allow tmux to connect to a tmux server. A tmux session is a single or collection of pseudo terminals running on the tmux server. Tmux can have multiple sessions per tmux server.

LinuxGSM now improves the handling of having mulitple game servers running by splitting up sockets and sessions as follows:

The socket name is now the servername plus a uid e.g csgoserver-f6d3a44b. This socket is shared by all game servers in the same installation (single installation with multiple instances). This means that every installation now has its own unique socket. The session name is the selfname of the game server e.g csgoserver or csgoserver-2 since you cant have two files with the same name in a directory this is also unique to the socket.

This change ensures there is no confusion when running two servers with the same name but in different installations (Single instance per installation) e.g /home/csgoserver/csgoserver and /home/csgoserver-2/csgoserver would previously have the same socket name potentually causing the wrong servers to be interacted with when stopping starting and accessing the console etc.

Type of change

  • Bug fix (a change which fixes an issue).
  • New feature (a change which adds functionality).
  • New Server (new server added).
  • Refactor (restructures existing code).
  • Comment update (typo, spelling, explanation, examples, etc).

Checklist

PR will not be merged until all steps are complete.

  • This pull request links to an issue.
  • This pull request uses the develop branch as its base.
  • This pull request subject follows the Conventional Commits standard.
  • This code follows the style guidelines of this project.
  • I have performed a self-review of my code.
  • I have checked that this code is commented where required.
  • I have provided a detailed enough description of this PR.
  • I have checked if documentation needs updating.

Documentation

If documentation does need updating either update it by creating a PR (preferred) or request a documentation update.

Thank you for your Pull Request!


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/GameServerManagers/LinuxGSM/pull/4296 **Author:** [@dgibbs64](https://github.com/dgibbs64) **Created:** 8/27/2023 **Status:** ✅ Merged **Merged:** 8/28/2023 **Merged by:** [@dgibbs64](https://github.com/dgibbs64) **Base:** `develop` ← **Head:** `feature/tmux-uniqueness` --- ### 📝 Commits (10+) - [`9c3ac62`](https://github.com/GameServerManagers/LinuxGSM/commit/9c3ac62b0b78125ff669d2b17c5672e48db3e82c) refactor: refactor tmux session handling - [`c0bd66d`](https://github.com/GameServerManagers/LinuxGSM/commit/c0bd66db41bdb7b1a9c423afde1a53353689c115) feat: stop server when generating uid - [`0e8e1a3`](https://github.com/GameServerManagers/LinuxGSM/commit/0e8e1a35db959581ec19124dff245a82b70ad81e) refactor: lockfile handling - [`e871833`](https://github.com/GameServerManagers/LinuxGSM/commit/e8718336010487fce12911836758c76cbf37a68d) refactor: improve backup and update monitoring - [`2cbfb5f`](https://github.com/GameServerManagers/LinuxGSM/commit/2cbfb5f95ff0ce2e54a1bcc75381a5511d11c475) refactor: improve logging in core_exit.sh - [`46d73f0`](https://github.com/GameServerManagers/LinuxGSM/commit/46d73f03a60700a0a82a0f255a67ba9f370d0d82) refactor: improve code readability and remove redundant code - [`3d6c92b`](https://github.com/GameServerManagers/LinuxGSM/commit/3d6c92ba05b05370adf3f21f85ef4a2ace9e7037) feat: add exitbypass flag to prevent lingering tmux sessions - [`d5a5639`](https://github.com/GameServerManagers/LinuxGSM/commit/d5a5639ecb4b0c7cd92180540aa3430794e8c56a) refactor: Refactor lockfile names for consistency and clarity - [`b4c6a2a`](https://github.com/GameServerManagers/LinuxGSM/commit/b4c6a2a407f22c20ef69aeb718dbdfde8038bbda) refactor: refactor check_last_update.sh, command_backup.sh, command_debug.sh, command_mods_remove.sh, command_monitor.sh, command_start.sh, command_stop.sh, command_ts3_server_pass.sh and core_steamcmd.sh - [`0c716de`](https://github.com/GameServerManagers/LinuxGSM/commit/0c716deb0bfbbcd1f51f4ed5c9a425c8be0d29bf) refactor: update lock file path in core_steamcmd.sh ### 📊 Changes **31 files changed** (+328 additions, -152 deletions) <details> <summary>View changed files</summary> 📝 `lgsm/modules/check_last_update.sh` (+7 -7) 📝 `lgsm/modules/check_status.sh` (+1 -1) 📝 `lgsm/modules/command_backup.sh` (+20 -8) 📝 `lgsm/modules/command_console.sh` (+1 -1) 📝 `lgsm/modules/command_debug.sh` (+6 -6) 📝 `lgsm/modules/command_mods_remove.sh` (+1 -1) 📝 `lgsm/modules/command_monitor.sh` (+148 -47) 📝 `lgsm/modules/command_restart.sh` (+1 -1) 📝 `lgsm/modules/command_send.sh` (+1 -1) 📝 `lgsm/modules/command_skeleton.sh` (+3 -0) 📝 `lgsm/modules/command_start.sh` (+48 -51) 📝 `lgsm/modules/command_stop.sh` (+21 -9) 📝 `lgsm/modules/command_ts3_server_pass.sh` (+2 -2) 📝 `lgsm/modules/command_update.sh` (+3 -0) 📝 `lgsm/modules/command_validate.sh` (+4 -1) 📝 `lgsm/modules/core_exit.sh` (+1 -1) 📝 `lgsm/modules/core_steamcmd.sh` (+4 -1) 📝 `lgsm/modules/fix_csgo.sh` (+1 -1) 📝 `lgsm/modules/fix_ts3.sh` (+13 -0) 📝 `lgsm/modules/info_distro.sh` (+1 -1) _...and 11 more files_ </details> ### 📄 Description # Description Refactor and improvements of tmux uniqueness, lock file handling and monitoring * Renaming lock files to new naming convention * Lock files for starting and stopping * Lock file for started * Lock file for backup * Lock file for monitoring * Lock file for updating * Lock file for last started * Lock file for last update * LinuxGSM now uses tmux socket name and a session name * Improved checks to prevent monitor from running when: * installer is running * backup is running * debug is running * server is stopping or starting * server is updating (but not when checking for updates) * monitor will reboot source engine servers if it detects the "request restart" message in the console * deprecate fn_start_teamspeak3 Fixes #2646 note this PR will force a game server to reboot to correct new session names via monitor command. Tmux uniqueness changes A socket is a pseudo-file that represents a network connection. Tmux creates a socket file to allow tmux to connect to a tmux server. A tmux session is a single or collection of pseudo terminals running on the tmux server. Tmux can have multiple sessions per tmux server. LinuxGSM now improves the handling of having mulitple game servers running by splitting up sockets and sessions as follows: The socket name is now the servername plus a uid e.g `csgoserver-f6d3a44b`. This socket is shared by all game servers in the same installation ([single installation with multiple instances](https://docs.linuxgsm.com/features/multiple-game-servers#single-installation-with-multiple-instances)). This means that every installation now has its own unique socket. The session name is the selfname of the game server e.g `csgoserver` or `csgoserver-2` since you cant have two files with the same name in a directory this is also unique to the socket. This change ensures there is no confusion when running two servers with the same name but in different installations ([Single instance per installation](https://docs.linuxgsm.com/features/multiple-game-servers#single-instance-per-installation)) e.g `/home/csgoserver/csgoserver` and `/home/csgoserver-2/csgoserver` would previously have the same socket name potentually causing the wrong servers to be interacted with when stopping starting and accessing the console etc. ## Type of change - [ ] Bug fix (a change which fixes an issue). - [x] New feature (a change which adds functionality). - [ ] New Server (new server added). - [ ] Refactor (restructures existing code). - [ ] Comment update (typo, spelling, explanation, examples, etc). ## Checklist PR will not be merged until all steps are complete. - [ ] This pull request links to an issue. - [x] This pull request uses the `develop` branch as its base. - [x] This pull request subject follows the Conventional Commits standard. - [x] This code follows the style guidelines of this project. - [x] I have performed a self-review of my code. - [x] I have checked that this code is commented where required. - [x] I have provided a detailed enough description of this PR. - [x] I have checked if documentation needs updating. ## Documentation If documentation does need updating either update it by creating a PR (preferred) or request a documentation update. - User docs: https://github.com/GameServerManagers/LinuxGSM-Docs - Dev docs: https://github.com/GameServerManagers/LinuxGSM-Dev-Docs **Thank you for your Pull Request!** --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
kerem 2026-02-27 04:54:36 +03:00
Sign in to join this conversation.
No labels
Atomic
Epic
cannot reproduce
command: backup
command: console
command: debug
command: details
command: fast-dl
command: install
command: mods
command: monitor
command: post-details
command: restart
command: send
command: start
command: stop
command: update
command: update-lgsm
command: validate
command: wipe
distro: AlmaLinux
distro: Arch Linux
distro: CentOS
distro: Debian
distro: Fedora
distro: RedHat
distro: Rocky Linux
distro: Ubuntu
distro: openSUSE
engine: goldsrc
engine: source
game: 7 Days to Die
game: ARMA 3
game: Ark: Survival Evolved
game: Assetto Corsa
game: Avorion
game: BATTALION: Legacy
game: Barotrauma
game: Battalion 1944
game: Battlefield 1942
game: Black Mesa: Deathmatch
game: Blade Symphony
game: Call of Duty 2
game: Call of Duty 4
game: Call of Duty: United Offensive
game: Counter-Strike 1.6
game: Counter-Strike 2
game: Counter-Strike: Global Offensive
game: Counter-Strike: Source
game: Day of Infamy
game: Dayz
game: Death Match Classic
game: Don't Starve Together
game: ET: Legacy
game: Eco
game: Factorio
game: Factorio
game: Garry's Mod
game: Half-Life
game: Hurtword
game: Insurgecy
game: Insurgecy
game: Insurgency: Sandstorm
game: Just Cause 3
game: Killing Floor
game: Killing Floor 2
game: Left 4 Dead 2
game: Minecraft
game: Minecraft Bedrock
game: Mordhau
game: Multi Theft Auto
game: Mumble
game: Natural Selection 2
game: No More Room in Hell
game: Pavlov VR
game: Post Scriptum
game: Project Zomboid
game: Quake 3
game: QuakeWorld
game: Red Orchestra: Ostfront 41-45
game: Return to Castle Wolfenstein
game: Rising World
game: Rust
game: San Andreas Multiplayer
game: Satisfactory
game: Soldat
game: Soldier of Fortune 2
game: Squad
game: Squad 44
game: Starbound
game: Stationeers
game: Sven Co-op
game: Team Fortress 2
game: Teamspeak 3
game: Teeworlds
game: Terraria
game: The Front
game: Unreal Tournament 2004
game: Unreal Tournament 3
game: Unreal Tournament 99
game: Unturned
game: Valheim
game: Wurm Unlimited
game: Zombie Master Reborn
game: label missing
good first issue
help wanted
info: alerts
info: dependency
info: docker
info: docs
info: email
info: query
info: steamcmd
info: systemd
info: tmux
info: website
info: website
needs more info
outcome: duplicate
outcome: issue resolved
outcome: issue resolved
outcome: issue unresolved
outcome: pr accepted
outcome: pr rejected
outcome: unconfirmed
outcome: wontfix
outcome: wrong forum
potential-duplicate
priority
pull-request
type: bug
type: feature
type: feature
type: feature request
type: game server request
type: refactor
waiting response
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/LinuxGSM#4296
No description provided.