GitBook: [master] 15 pages and 2 assets modified

SUMMARY.md

@@ -28,6 +28,7 @@
   * [fastdl](commands/fastdl.md)
   * [change-password](commands/change-password.md)
 * [Game Servers](game-servers/README.md)
+  * [Insurgency: SandStorm](game-servers/insurgency-sandstorm.md)
   * [7 Days to Die](game-servers/7-days-to-die.md)
   * [Arma 3](game-servers/arma-3.md)
   * [ARK: Survival Evolved](game-servers/ark-survival-evolved.md)

configuration/cronjobs.md

@@ -1,198 +1,140 @@
 # cronjobs
 
-## Automation with cronjobs
+To automate LinuxGSM you can set scheduled tasks using cronjobs, to run any command at any given time.
 
-You can set scheduled tasks with cronjobs, to run any function at any given time.
-
-Most used ones are:
+Commonly used scheduled tasks are:
 
 * Automatically check for updates [\(update command\)](../commands/update.md)
 * Automatically check for server crash and restart if needed [\(monitor command\)](../commands/monitor.md)
-* Automatically keep LinuxGSM up to date [\(update-functions command\)](../commands/update-lgsm.md)
+* Automatically keep LinuxGSM up to date [\(update-lgsm command\)](../commands/update-lgsm.md)
 * Automatically restart the server at a given time [\(restart command\)](../commands/start-stop-restart.md)
 * Automatically update and restart the server [\(force-update command\)](../commands/force-update.md)
 
-## Command
+## Crontab
 
-To access and edit your cronjobs, input  
-`crontab -e`
+To access and edit your cronjobs use crontab.
 
-## Cronjob as user or root
+```bash
+crontab -e
+```
 
-When setting up cronjobs there is a choice of running them as a user or as root. If an admin runs several servers and wants to centrally manage cronjobs then using the root crontab is a good idea. If an admin wants them separated, the user crontab is best.
+## Cronjob as a user or root
 
-## Crontab Syntax
+It is possible to set up cronjobs as any user including root. The recommended way is to set up cronjobs using the game servers user account. However, If you run several game server installations on your server you may want to centrally manage cronjobs then using root. 
 
-### User cronjobs
+### User cronjob
 
 ```bash
 * * * * * [/path/to/script] [command] > /dev/null 2>&1
 ```
 
-### Root cronjobs
+### Root cronjob
 
 ```bash
 * * * * * su - username -c '[/path/to/script] [command]' > /dev/null 2>&1
 ```
 
-> Note: `>/dev/null 2>&1` is required to mute any output.
+## **Cronjob Timing Examples**
 
-### Temporal values
+### Every single minute
 
-`*` can be considered as "bypass" values by some, but means "whatever the value is, do it".  
-You can replace them by numerical values standing for  
-**minutes** - **hours** \(24h format\) - **days** - **month** - **day of the week** \(Sunday =0 to Saturday =6\)
+```bash
+* * * * *
+```
 
-A numerical `x` value would mean "when it is this value".  
-While a `*/x` means every `x` time.
+### Every 30 minutes
 
-Of course, you can combine those rules smartly to achieve what you want.
+```bash
+*/30 * * * *
+```
 
-**Every "x" time**
+### Every hour
+
+```bash
+0 * * * *
+```
 
-In order to run a command, such as "monitor" every "x" time, there is a simple solution.  
-Replace `*` by `*/x`, "x" being the desired numerical value.  
-Think about defining smaller amounts of time to a fixed value when using this. For example, if you wish to have an "every two hours" cronjob, you'll need to set a fixed value for minutes.
+### Every two hours
 
-**Temporal values examples**
+```bash
+0 */2 * * *
+```
 
-Every single minute  
-`* * * * *`
+### Every two hours at 30 minutes past the hour 
 
-Every 30 minutes  
-`*/30 * * * *`
+```bash
+30 */2 * * *
+```
 
-Every hour  
-`0 * * * *`
+### Every day at 5:10 PM
 
-Every two hours  
-`0 */2 * * *`
+```bash
+10 17 * * *
+```
 
-Every two hours when it's 30 minutes on the clock `30 */2 * * *`
+### Every Wednesday at 1 AM
 
-Every day at 5:10 PM  
-`10 17 * * *`
+```bash
+0 1 * * * 3
+```
 
-Every Wednesday at 1 AM  
-`0 1 * * * 3`
+### Every Five Days at 1 AM
 
-Every five days at 1 AM  
-`0 1 */5 * *`
+```bash
+0 1 */5 * *
+```
 
-#### Cronjob generator
+## Cronjob Generator
 
-If you have any doubt about a particular syntax, you can use this generator : [http://crontab-generator.org/](http://crontab-generator.org/)
+If you are not used to setting up cronjobs you can use [crontab.guru](https://crontab.guru) as a great reference to get started.
 
 ## LinuxGSM Cronjobs examples
 
-### Daily cronjobs
+{% hint style="info" %}
+Replace username and gameserver with your own details.
+{% endhint %}
 
-**Replace the username and gameserver according to your case**
+### Daily cronjob
 
-Here is an example of a user based cronjob for daily restart at 5am :
+Here is an example of a user based cronjob for a daily restart at 5 am.
 
 ```bash
 0 5 * * *  /home/username/gameserver restart > /dev/null 2>&1
 ```
 
-Here is an example of a root based cronjob for daily restart at 5am :
+Here is an example of a root based cronjob for a daily restart at 5 am.
 
 ```bash
 0 5 * * *  su - username -c '/home/username/gameserver restart' > /dev/null 2>&1
 ```
 
-### Every x time cronjobs
-
-**Replace the username and gameserver according to your case**
+### Every X Time cronjobs
 
-Here is an example of a user based cronjob to monitor your server every 3 minutes :
+Here is an example of a user based cronjob to monitor your server every 5 minutes.
 
 ```bash
-*/3 * * * *  /home/username/gameserver monitor > /dev/null 2>&1
+*/5 * * * *  /home/username/gameserver monitor > /dev/null 2>&1
 ```
 
-Here is an example of a root based cronjob to monitor your server every 3 minutes :
+Here is an example of a root based cronjob to monitor your server every 5 minutes.
 
 ```bash
-*/3 * * * *  su - username -c '/home/username/gameserver monitor' > /dev/null 2>&1
+*/5 * * * *  su - username -c '/home/username/gameserver monitor' > /dev/null 2>&1
 ```
 
-## Full examples
-
-### Complete setup for one gameserver
-
-**Replace the username and gameserver according to your case**
-
-```bash
-####CRONJOBS####
-
-### Game Name
-#Server Name
-*/5 * * * * su - username -c '/home/username/gameserver monitor' > /dev/null 2>&1
-*/30 * * * * su - username -c '/home/username/gameserver update' > /dev/null 2>&1
-30 6 * * *  su - username -c '/home/username/gameserver force-update' > /dev/null 2>&1
-0 0 * * 0 su - username -c '/home/username/gameserver update-functions' > /dev/null 2>&1
-```
+## Complete Example
 
-* Will monitor your server every 5 minutes
-* Will check for an update every 30 minutes, update and restart only if an update is detected.
-* Will restart and check for an update every day at 6:30 AM
-* Will update your LinuxGSM functions every Sunday at midnight.
+Below is a recommended basic example and will do the following:
 
-#### Real life multiple servers example
+* Monitor your server every 5 minutes.
+* Check for an update every 30 minutes, update and restart only if an update is detected.
+* Restart and check for an update every day at 4:30 AM
+* Update check and update LinuxGSM every Sunday at midnight.
 
 ```bash
-####CRONJOBS####
-
-###TeamSpeak###
-# TS3Community
-*/1 * * * *  su - ts3server -c '/home/ts3server/ts3server monitor' > /dev/null 2>&1
-30 6 * * *  su - ts3server -c '/home/ts3server/ts3server update' > /dev/null 2>&1
-0 0 * * 0 su - ts3server -c '/home/ts3server/ts3server uf' > /dev/null 2>&1
-
-###GMOD###
-# ProBuild
-*/2 * * * *  su - gmodprobuild -c '/home/gmodprobuild/gmodserver monitor' > /dev/null 2>&1
-0 5 * * *  su - gmodprobuild -c '/home/gmodprobuild/gmodserver fu' > /dev/null 2>&1
-0 0 * * 0 su - gmodprobuild -c '/home/gmodprobuild/gmodserver uf' > /dev/null 2>&1
-# Prophunt
-*/2 * * * *  su - gmodprophunt -c '/home/gmodprophunt/gmodserver monitor' > /dev/null 2>&1
-0 5 * * *  su - gmodprophunt -c '/home/gmodprophunt/gmodserver fu' > /dev/null 2>&1
-0 0 * * 0 su - gmodprophunt -c '/home/gmodprophunt/gmodserver uf' > /dev/null 2>&1
-
-
-###CSS###
-# GunGame
-*/2 * * * *  su - cssgungame -c '/home/cssgungame/cssserver monitor' > /dev/null 2>&1
-30 5 * * *  su - cssgungame -c '/home/cssgungame/cssserver fu' > /dev/null 2>&1
-0 0 * * 0 su - cssgungame -c '/home/cssgungame/cssserver uf' > /dev/null 2>&1
-
-###RUST###
-# Modded
-## Server stopped
-#*/5 * * * * su - rustmodded -c '/home/rustmodded/rustserver monitor' > /dev/null 2>&1
-#30 6 * * *  su - rustmodded -c '/home/rustmodded/zip-updater/zip-updater' > /dev/null 2>&1
-#0 0 * * 0 su - rustmodded -c '/home/rustmodded/rustserver uf' > /dev/null 2>&1
-
-#Vanilla
-*/5 * * * * su - rustvanilla -c '/home/rustvanilla/rustserver monitor' > /dev/null 2>&1
-*/30 * * * * su - rustvanilla -c '/home/rustvanilla/rustserver update' > /dev/null 2>&1
-30 6 * * *  su - rustvanilla -c '/home/rustvanilla/rustserver fu' > /dev/null 2>&1
-0 0 * * 0 su - rustvanilla -c '/home/rustvanilla/rustserver uf' > /dev/null 2>&1
-
-###ARK###
-*/30 * * * * su - arkserver -c '/home/arkserver/arkserver monitor' > /dev/null 2>&1
-0 6 * * 5  su - arkserver -c '/home/arkserver/arkserver fu' > /dev/null 2>&1
-0 */1 * * * su - arkserver -c '/home/arkserver/arkserver update' > /dev/null 2>&1
-0 0 * * 0 su - arkserver -c '/home/arkserver/arkserver uf' > /dev/null 2>&1
+*/5 * * * * /home/username/gameserver monitor > /dev/null 2>&1
+*/30 * * * * /home/username/gameserver update > /dev/null 2>&1
+30 4 * * *  /home/username/gameserver force-update > /dev/null 2>&1
+0 0 * * 0 /home/username/gameserver update-lgsm > /dev/null 2>&1
 ```
 
-**Protips**
-
-* Note the "fu" \(for "force-update"\) which will check for an update and restart your server even though there is no update. It is a good alternative if you don't wish to use the update on start functionality.
-* It's a good practice to comment cronjob lines of a server that you momentarily want to shutdown in order to add back cronjobs more easily afterwards.
-* Some servers crash more often, so it's a good idea to monitor them more frequently. However, you shouldn't monitor faster than once every 2 minutes, otherwise the monitor function might behave inconsistently, and your server might bootloop.
-* You can also sparingly run "every x time" update checks, for games getting updated a lot.
-* As you can see for the commented Rust server, you can also run your own custom scripts if the task is more complicated than just an LinuxGSM command.
-* Ultimately, it's wise to add an "uf" cronjob \(for "update-functions"\) in order to keep LinuxGSM up to date.
-