Skip to content

Commit

Permalink
Fixed markdownlint errors
Browse files Browse the repository at this point in the history
  • Loading branch information
MicLieg committed Aug 7, 2024
1 parent bced823 commit 20f73aa
Show file tree
Hide file tree
Showing 114 changed files with 1,521 additions and 1,628 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
# Home



<figure><img src=".gitbook/assets/LinuxGSM_github_header.jpg" alt=""><figcaption></figcaption></figure>

The command-line tool for quick, simple deployment and management of Linux dedicated game servers.

* User docs: [docs.linuxgsm.com](https://docs.linuxgsm.com)
* Dev Docs: [dev-docs.linuxgsm.com](https://dev-docs.linuxgsm.com)
- User docs: [docs.linuxgsm.com](https://docs.linuxgsm.com)
- Dev Docs: [dev-docs.linuxgsm.com](https://dev-docs.linuxgsm.com)

## Welcome

Expand Down
202 changes: 101 additions & 101 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,103 +1,103 @@
# Table of contents

* [Home](README.md)
* [Getting Started](getting-started.md)
* [Configuration](configuration/README.md)
* [LinuxGSM Config](configuration/linuxgsm-config.md)
* [Game Server Config](configuration/game-server-config.md)
* [Start Parameters](configuration/start-parameters.md)
* [cronjobs](configuration/cronjobs.md)
* [Running on Boot](configuration/running-on-boot.md)
* [Running Multiple Game Servers](configuration/multiple-game-servers.md)
* [IP Address Configuration](configuration/ip-address-configuration.md)
* [LinuxGSM Stats](configuration/linuxgsm-stats.md)
* [Commands](commands/README.md)
* [install](commands/install.md)
* [start-stop-restart](commands/start-stop-restart.md)
* [monitor](commands/monitor.md)
* [test-alert](commands/test-alert.md)
* [console](commands/console.md)
* [debug](commands/debug.md)
* [update](commands/update.md)
* [check-update](commands/check-update.md)
* [force-update](commands/force-update.md)
* [validate](commands/validate.md)
* [update-lgsm](commands/update-lgsm.md)
* [backup](commands/backup.md)
* [map-compressor](commands/map-compressor.md)
* [details](commands/details.md)
* [mods](commands/mods.md)
* [skeleton](commands/skeleton.md)
* [fastdl](commands/fastdl.md)
* [change-password](commands/change-password.md)
* [Game Servers](game-servers/README.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)
* [Call of Duty 4](game-servers/call-of-duty-4.md)
* [Dont Starve Together](game-servers/dont-starve-together.md)
* [Counter-Strike 2](game-servers/counter-strike-2.md)
* [Counter-Strike: Global Offensive](game-servers/counter-strike-global-offensive.md)
* [Factorio](game-servers/factorio.md)
* [Garry's Mod](game-servers/garrys-mod/README.md)
* [Insurgency: SandStorm](game-servers/insurgency-sandstorm.md)
* [Killing Floor 2](game-servers/killing-floor-2.md)
* [Minecraft: Java Edition](game-servers/minecraft.md)
* [Multi Theft Auto](game-servers/multi-theft-auto.md)
* [Rust](game-servers/rust.md)
* [Sven Co-op](game-servers/sven-co-op.md)
* [TeamSpeak 3](game-servers/teamspeak-3.md)
* [Unreal Tournament 99](game-servers/unreal-tournament-99.md)
* [Unreal Tournament 2004](game-servers/unreal-tournament-2004.md)
* [Unreal Tournament 3](game-servers/unreal-tournament-3.md)
* [Valheim](game-servers/valheim.md)
* [The Front \[WIP\]](game-servers/the-front-wip.md)
* [Networking](networking/README.md)
* [IP Address](networking/ip-address.md)
* [Ports](networking/ports.md)
* [Source Engine](networking/source-engine.md)
* [Alerts](alerts/README.md)
* [Discord](alerts/discord.md)
* [Email](alerts/email.md)
* [IFTTT](alerts/ifttt.md)
* [Pushbullet](alerts/pushbullet.md)
* [Pushover](alerts/pushover.md)
* [Rocket.Chat](alerts/rocket.chat.md)
* [Slack](alerts/slack.md)
* [Telegram](alerts/telegram.md)
* [Dependencies](requirements/README.md)
* [Java](requirements/java.md)
* [tmux](requirements/tmux.md)
* [jq](requirements/jq.md)
* [gamedig](requirements/gamedig.md)
* [glibc](requirements/glibc.md)
* [Features](features/README.md)
* [ANSI Colors](features/ansi-colors.md)
* [Stop Mode](features/stop-mode.md)
* [Log Management](features/logging.md)
* [Message Display Time](features/message-display-time.md)
* [SteamCMD](steamcmd/README.md)
* [Steam Master Server](steamcmd/steam-master-server.md)
* [Game Server Login Token](steamcmd/gslt.md)
* [Branch](steamcmd/branch.md)
* [LAN Discovery](steamcmd/lan-discovery.md)
* [Workshop](steamcmd/workshop.md)
* [Error Codes](steamcmd/errors.md)
* [Linux](linux/README.md)
* [distro](linux/distro.md)
* [ftp-scp](linux/ftp-scp.md)
* [file-ownership](linux/file-ownership.md)
* [firewalls](linux/firewalls.md)
* [network-interfaces](linux/network-interfaces.md)
* [permissions](linux/permissions.md)
* [Symlinking and ln command](linux/save-space-with-symlinking.md)
* [Troubleshooting](troubleshooting.md)
* [FAQ](support/faq.md)
* [Guides](guides/README.md)
* [Security](guides/security.md)
* [Make Webserver Case Insensitive](guides/make-webserver-case-insensitive.md)
* [Sourcemod and Metamod:Source](guides/sourcemod-csgo-server.md)
* [Other](other/README.md)
* [server-migration](other/server-migration.md)
* [basic-usage](other/basic-usage.md)
* [brand](other/brand.md)
- [Home](README.md)
- [Getting Started](getting-started.md)
- [Configuration](configuration/README.md)
- [LinuxGSM Config](configuration/linuxgsm-config.md)
- [Game Server Config](configuration/game-server-config.md)
- [Start Parameters](configuration/start-parameters.md)
- [cronjobs](configuration/cronjobs.md)
- [Running on Boot](configuration/running-on-boot.md)
- [Running Multiple Game Servers](configuration/multiple-game-servers.md)
- [IP Address Configuration](configuration/ip-address-configuration.md)
- [LinuxGSM Stats](configuration/linuxgsm-stats.md)
- [Commands](commands/README.md)
- [install](commands/install.md)
- [start-stop-restart](commands/start-stop-restart.md)
- [monitor](commands/monitor.md)
- [test-alert](commands/test-alert.md)
- [console](commands/console.md)
- [debug](commands/debug.md)
- [update](commands/update.md)
- [check-update](commands/check-update.md)
- [force-update](commands/force-update.md)
- [validate](commands/validate.md)
- [update-lgsm](commands/update-lgsm.md)
- [backup](commands/backup.md)
- [map-compressor](commands/map-compressor.md)
- [details](commands/details.md)
- [mods](commands/mods.md)
- [skeleton](commands/skeleton.md)
- [fastdl](commands/fastdl.md)
- [change-password](commands/change-password.md)
- [Game Servers](game-servers/README.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)
- [Call of Duty 4](game-servers/call-of-duty-4.md)
- [Dont Starve Together](game-servers/dont-starve-together.md)
- [Counter-Strike 2](game-servers/counter-strike-2.md)
- [Counter-Strike: Global Offensive](game-servers/counter-strike-global-offensive.md)
- [Factorio](game-servers/factorio.md)
- [Garry's Mod](game-servers/garrys-mod/README.md)
- [Insurgency: SandStorm](game-servers/insurgency-sandstorm.md)
- [Killing Floor 2](game-servers/killing-floor-2.md)
- [Minecraft: Java Edition](game-servers/minecraft.md)
- [Multi Theft Auto](game-servers/multi-theft-auto.md)
- [Rust](game-servers/rust.md)
- [Sven Co-op](game-servers/sven-co-op.md)
- [TeamSpeak 3](game-servers/teamspeak-3.md)
- [Unreal Tournament 99](game-servers/unreal-tournament-99.md)
- [Unreal Tournament 2004](game-servers/unreal-tournament-2004.md)
- [Unreal Tournament 3](game-servers/unreal-tournament-3.md)
- [Valheim](game-servers/valheim.md)
- [The Front ](game-servers/the-front-wip.md)
- [Networking](networking/README.md)
- [IP Address](networking/ip-address.md)
- [Ports](networking/ports.md)
- [Source Engine](networking/source-engine.md)
- [Alerts](alerts/README.md)
- [Discord](alerts/discord.md)
- [Email](alerts/email.md)
- [IFTTT](alerts/ifttt.md)
- [Pushbullet](alerts/pushbullet.md)
- [Pushover](alerts/pushover.md)
- [Rocket.Chat](alerts/rocket.chat.md)
- [Slack](alerts/slack.md)
- [Telegram](alerts/telegram.md)
- [Dependencies](requirements/README.md)
- [Java](requirements/java.md)
- [tmux](requirements/tmux.md)
- [jq](requirements/jq.md)
- [gamedig](requirements/gamedig.md)
- [glibc](requirements/glibc.md)
- [Features](features/README.md)
- [ANSI Colors](features/ansi-colors.md)
- [Stop Mode](features/stop-mode.md)
- [Log Management](features/logging.md)
- [Message Display Time](features/message-display-time.md)
- [SteamCMD](steamcmd/README.md)
- [Steam Master Server](steamcmd/steam-master-server.md)
- [Game Server Login Token](steamcmd/gslt.md)
- [Branch](steamcmd/branch.md)
- [LAN Discovery](steamcmd/lan-discovery.md)
- [Workshop](steamcmd/workshop.md)
- [Error Codes](steamcmd/errors.md)
- [Linux](linux/README.md)
- [distro](linux/distro.md)
- [ftp-scp](linux/ftp-scp.md)
- [file-ownership](linux/file-ownership.md)
- [firewalls](linux/firewalls.md)
- [network-interfaces](linux/network-interfaces.md)
- [permissions](linux/permissions.md)
- [Symlinking and ln command](linux/save-space-with-symlinking.md)
- [Troubleshooting](troubleshooting.md)
- [FAQ](support/faq.md)
- [Guides](guides/README.md)
- [Security](guides/security.md)
- [Make Webserver Case Insensitive](guides/make-webserver-case-insensitive.md)
- [Sourcemod and Metamod:Source](guides/sourcemod-csgo-server.md)
- [Other](other/README.md)
- [server-migration](other/server-migration.md)
- [basic-usage](other/basic-usage.md)
- [brand](other/brand.md)
6 changes: 2 additions & 4 deletions alerts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,18 @@ Alert settings can be changed in [LinuxGSM config](../configuration/linuxgsm-con

More info allows you to get further info about an alert using hastebin.com. Many alerts only give basic info, unlike email. More info displays the same output as email in a link within a basic alert.

```
```bash
# More info | https://docs.linuxgsm.com/alerts#more-info
postalert="off"
```

###

### Display IP

The IP address you want to be displayed in alerts.

By default, the LinuxGSM alert will display the external internet facing IP. Failing this will fall back to the server IP. If the IP is incorrect it can be manually set using `displayip=""`.

```
```bash
# Display IP | https://docs.linuxgsm.com/alerts#display-ip
displayip=""
```
4 changes: 2 additions & 2 deletions alerts/discord.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Discord

![](<../.gitbook/assets/discord\_logo (1).png>)
![Discord Logo](<../.gitbook/assets/discord_logo (1).png>)

[Discord](https://discordapp.com) is a VoIP app that allows other applications to send messages via a webhook. This functionality is used to allow users to recieve alerts about LinuxGSM.

Expand All @@ -15,7 +15,7 @@ A webhook is required to post alerts to a Discord text channel
5. Copy the Webhook URL
6. Turn on discord alert and enter the URL in to the [LinuxGSM settings](../configuration/linuxgsm-config.md). (`~/lgsm/config-lgsm/<gameserver>/common.cfg`)

```
```bash
# Discord Alerts | https://github.com/GameServerManagers/LinuxGSM/wiki/Discord
discordalert="on"
discordwebhook="https://discordapp.com/api/webhooks/3539332633367897009/5t_K4GkuBaR2-69TsKqXmHIya1ck1tirnu_Fst-DUC00dye98eaa_I6uTIcHEsi7a17K"
Expand Down
16 changes: 8 additions & 8 deletions alerts/ifttt.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# IFTTT

![](../.gitbook/assets/ifttt\_logo.png)
![IFTT Logo](../.gitbook/assets/ifttt_logo.png)

There are hundreds in integrations available on [IFTTT](https://ifttt.com) allowing you to send alerts in all sorts of different ways to various services and devices. This functionality is used to allow users to recieve alerts about LinuxGSM.

## Setup IFTTT Webhook

To enable IFTTT you will need to setup a Webhooks integration.

1. Visit [https://ifttt.com/maker\_webhooks](https://ifttt.com/maker\_webhooks)
1. Visit [https://ifttt.com/maker_webhooks](https://ifttt.com/maker_webhooks)
2. Login and connect the Webhooks integration
3. Select `Documentation` to get your IFTTT API key.
4. Paste the API key into [LinuxGSM settings](../configuration/linuxgsm-config.md).

```
```bash
# IFTTT Alerts | https://github.com/GameServerManagers/LinuxGSM/wiki/IFTTT
iftttalert="off"
ifttttoken="e-Yg8blVGDA15ewWvtZjUe"
Expand All @@ -24,7 +24,7 @@ iftttevent=""

An event name is a word used to trigger IFTTT event. This word is used when setting up an applet and can be any word you choose.

```
```bash
# IFTTT Alerts | https://github.com/GameServerManagers/LinuxGSM/wiki/IFTTT
iftttalert="off"
ifttttoken="e-Yg8blVGDA15ewWvtZjUe"
Expand All @@ -35,11 +35,11 @@ iftttevent="linuxgsm_alert"

IFTTT allows 3 different values to be sent using the webhook; `Value1`, `Value2` and `Value3`. LinuxGSM sends different data for each value as listed below.

* Value1: Sends the name of the server e.g `csgoserver`
* Value2: Sends an alert subject e.g `Alert - csgoserver - Test`
* Value3: Sends an alert summary message.
- Value1: Sends the name of the server e.g `csgoserver`
- Value2: Sends an alert subject e.g `Alert - csgoserver - Test`
- Value3: Sends an alert summary message.

```
```bash
Testing LinuxGSM Alert. No action to be taken.
Game Squad
Server name LinuxGSM Server 1
Expand Down
4 changes: 2 additions & 2 deletions alerts/pushbullet.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Pushbullet

![](<../.gitbook/assets/pushbullet\_logo (1).png>)
![Pushbullet Logo](<../.gitbook/assets/pushbullet_logo (1).png>)

[Pushbullet](https://www.pushbullet.com) allows the sending of push notifications to various devices such a PC, phone and tablet. This functionality is used to allow users to recieve alerts about LinuxGSM.

Expand All @@ -25,6 +25,6 @@ Visit [here](https://www.pushbullet.com/my-channel) to generate a channel.

Once you have created the channel set the channeltag in the script without using hash `#`.

```
```bash
channeltag="myepicserver"
```
8 changes: 4 additions & 4 deletions alerts/pushover.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Pushover

![](../.gitbook/assets/pushover\_logo.png)
![Pushover Logo](../.gitbook/assets/pushover_logo.png)

[Pushover](https://pushover.net) allows the sending of push notifications to various devices such a PC, phone and tablet. This functionality is used to allow users to receive alerts about LinuxGSM.

Expand All @@ -10,13 +10,13 @@ A Pushover application and your user key is required to send messages to Pushove

Visit [here](https://pushover.net/apps/build) to create a new application.

* name: LinuxGSM
* Check the box agreeing to the Terms Of Service.
- name: LinuxGSM
- Check the box agreeing to the Terms Of Service.

Once the application has been created get the API key and user key (which can be found in the pushover dashboard).\
Turn on Pushover alerts and paste in API key and user key in the [LinuxGSM config](../configuration/linuxgsm-config.md).

```
```bash
# Pushover Alerts | https://github.com/GameServerManagers/LinuxGSM/wiki/Pushover
pushoveralert="on"
pushoveruserkey="yourpushoverid"
Expand Down
9 changes: 2 additions & 7 deletions alerts/rocket.chat.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
# Rocket.Chat

![](../.gitbook/assets/rocket.chat.jpg)
![Rocket.Chat Logo](../.gitbook/assets/rocket.chat.jpg)

**Rocket.chat** is an open-source collaboration tool.

## Create a Rocket.chat Webhook

1. Follow the [Rocket.chat guide](https://docs.rocket.chat/guides/administrator-guides/integrations#incoming-webhook-script) on how to create an incoming webhook.
2. Copy the Webhook URL.
3. Turn on Rocket.chat alerts and copy the URL into the [LinuxGSM settings](../configuration/linuxgsm-config.md). \(`~/lgsm/config-lgsm/<gameserver>/common.cfg`\)





3. Turn on Rocket.chat alerts and copy the URL into the [LinuxGSM settings](../configuration/linuxgsm-config.md). \(`~/lgsm/config-lgsm/<gameserver>/common.cfg`\)
5 changes: 2 additions & 3 deletions alerts/slack.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Slack

![](../.gitbook/assets/slack_logo.png)
![Slack logo](../.gitbook/assets/slack_logo.png)

[Slack](https://slack.com) is a cloud-based set of proprietary team collaboration software tools and online services.

Expand All @@ -12,9 +12,8 @@ A webhook is required to post alerts to a slack.
2. Copy the Webhook URL
3. Turn on slack alerts and enter the URL in to the [LinuxGSM settings](../configuration/linuxgsm-config.md). \(`~/lgsm/config-lgsm/<gameserver>/common.cfg`\)

```text
```bash
# Slack Alerts | https://docs.linuxgsm.com/alerts/slack
slackalert="on"
slackwebhook="your webhook url"
```

Loading

0 comments on commit 20f73aa

Please sign in to comment.