[PR #4508] feat(cron): add toggle-cronjobs command #4360

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

📋 Pull Request Information

Original PR: https://github.com/GameServerManagers/LinuxGSM/pull/4508
Author: @MicLieg
Created: 2/25/2024
Status: 🔄 Open

Base: developHead: feature/toggle-cronjobs-command


📝 Commits (2)

  • 5392ba8 feat(cron): add toggle-cronjobs command for automatically (un-)installing cronjobs
  • 5856a8a fix codacy static code analysis

📊 Changes

4 files changed (+86 additions, -1 deletions)

View changed files

📝 lgsm/modules/check.sh (+1 -1)
lgsm/modules/command_toggle_cronjobs.sh (+76 -0)
📝 lgsm/modules/core_getopt.sh (+4 -0)
📝 lgsm/modules/core_modules.sh (+5 -0)

📄 Description

Description

This pull request introduces a new command: ./gameserver toggle-cronjobs

This command simplifies cronjob management for LinuxGSM users and auto deployment scripts, making it easier to ensure that server monitoring, updates, and restarts are performed automatically according to the specified schedules.

The toggle-cronjobs command operates by identifying whether cronjobs, using the specified LinuxGSM commands, exist within the system's crontab and wehter these were aded by LinuxGSM:

  1. If there is no cronjob using the specified LinuxGSM command, a new cronjob will be created for the specified command.
  2. If there is a cronjob using the specified LinuxGSM command that was added by LinuxGSM, the cronjob will be removed.
  3. If there is a cronjob using the specified LinuxGSM command that was NOT added by LinuxGSM, the specified LinuxGSM command will be skipped and no cronjob will be added or removed.

I've chosen to include similar cronjobs as the Example cronjobs:

fn_toggle_cronjob "monitor" "*/5 * * * *" # Every 5 minutes
fn_toggle_cronjob "update" "*/30 * * * *" # Every 30 minutes
fn_toggle_cronjob "update-lgsm" "0 0 * * *" # Daily at midnight
fn_toggle_cronjob "restart" "30 4 * * *" # Daily at 4:30am

Currently the output of all LinuxGSM managed cronjobs including all erros will be sent to /dev/null. It might be woth saving the logs to LinuxGSM's log dir.

Fixes #4329

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.
    • I will add documentation once I get feedback on whether this PR will be merged.

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/4508 **Author:** [@MicLieg](https://github.com/MicLieg) **Created:** 2/25/2024 **Status:** 🔄 Open **Base:** `develop` ← **Head:** `feature/toggle-cronjobs-command` --- ### 📝 Commits (2) - [`5392ba8`](https://github.com/GameServerManagers/LinuxGSM/commit/5392ba89d613a4a44ef43cb47be85721a0024e38) feat(cron): add toggle-cronjobs command for automatically (un-)installing cronjobs - [`5856a8a`](https://github.com/GameServerManagers/LinuxGSM/commit/5856a8a6706e651d3bf38d394cd0cabcf7c04111) fix codacy static code analysis ### 📊 Changes **4 files changed** (+86 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `lgsm/modules/check.sh` (+1 -1) ➕ `lgsm/modules/command_toggle_cronjobs.sh` (+76 -0) 📝 `lgsm/modules/core_getopt.sh` (+4 -0) 📝 `lgsm/modules/core_modules.sh` (+5 -0) </details> ### 📄 Description # Description This pull request introduces a new command: `./gameserver toggle-cronjobs` This command simplifies cronjob management for LinuxGSM users and auto deployment scripts, making it easier to ensure that server monitoring, updates, and restarts are performed automatically according to the specified schedules. The `toggle-cronjobs` command operates by identifying whether cronjobs, using the specified LinuxGSM commands, exist within the system's crontab and wehter these were aded by LinuxGSM: 1. If there is no cronjob using the specified LinuxGSM command, a new cronjob will be created for the specified command. 2. If there is a cronjob using the specified LinuxGSM command that was added by LinuxGSM, the cronjob will be removed. 3. If there is a cronjob using the specified LinuxGSM command that was NOT added by LinuxGSM, the specified LinuxGSM command will be skipped and no cronjob will be added or removed. I've chosen to include similar cronjobs as the [Example cronjobs](https://docs.linuxgsm.com/configuration/cronjobs#complete-example): > `fn_toggle_cronjob "monitor" "*/5 * * * *" # Every 5 minutes` > `fn_toggle_cronjob "update" "*/30 * * * *" # Every 30 minutes` > `fn_toggle_cronjob "update-lgsm" "0 0 * * *" # Daily at midnight` > `fn_toggle_cronjob "restart" "30 4 * * *" # Daily at 4:30am` Currently the output of all LinuxGSM managed cronjobs including all erros will be sent to `/dev/null`. It might be woth saving the logs to LinuxGSM's log dir. Fixes #4329 ## 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. - [x] 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. - [ ] I have checked if documentation needs updating. - I will add documentation once I get feedback on whether this PR will be merged. ## 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>
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#4360
No description provided.