You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: alerts/discord.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Discord
2
2
3
-
3
+
4
4
5
5
[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.
Copy file name to clipboardexpand all lines: alerts/ifttt.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# IFTTT
2
2
3
-
3
+
4
4
5
5
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.
Copy file name to clipboardexpand all lines: alerts/mailgun.md
+3-2
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
[Mailgun](https://www.mailgun.com) is a paid-for email service that allows LinuxGSM to send emails via an API, bypassing the need to use postfix. This method of sending email notifications is generally more reliable.
6
6
7
-
An option to setup Mailgun as an email relay in postfix is also available.
7
+
An option to setup Mailgun as an email relay in postfix is also available.
8
8
9
9
Mailgun's Flex Package allows 3 free months up to 5000 emails then turns into a pay-as-you-go plan afterwards.
Copy file name to clipboardexpand all lines: alerts/pushover.md
+14-13
Original file line number
Diff line number
Diff line change
@@ -2,23 +2,24 @@
2
2
3
3
4
4
5
-
[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 recieve alerts about LinuxGSM.
5
+
[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.
6
6
7
7
## Setup Pushover Alerts
8
8
9
-
A Pushover application is required to send messages to Pushover. 1. Visit [here](https://pushover.net/apps/build) to create a new application.
9
+
A Pushover application and your user key is required to send messages to Pushover.
10
+
11
+
Visit [here](https://pushover.net/apps/build) to create a new application.
10
12
11
13
* name: LinuxGSM
12
-
* type: Script
13
-
* icon:
14
14
* Check the box agreeing to the Terms Of Service.
15
-
* Once the application has been created get the API key.
16
-
* Turn on Pushover alerts and paste in API key and user in the [LinuxGSM config](../configuration/linuxgsm-config.md).
**Rocket.chat** is open-source collaberation tool.
6
+
7
+
## Create a Rocket.chat Webhook
8
+
9
+
1. Follow the [Rocket.chat guide](https://docs.rocket.chat/guides/administrator-guides/integrations#incoming-webhook-script) on how to create an incoming webhook.
10
+
2. Copy the Webhook URL.
11
+
3. Turn on slack alerts and enter the URL in to the [LinuxGSM settings](../configuration/linuxgsm-config.md). \(`~/lgsm/config-lgsm/<gameserver>/common.cfg`\)
Copy file name to clipboardexpand all lines: alerts/telegram.md
+6-2
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Telegram
2
2
3
-
[Telegram](https://telegram.org) is an instant messenger app that allows other applications to send messages via a webhook. This functionality is used to allow users to recieve alerts about LinuxGSM.
3
+
[Telegram](https://telegram.org) is an instant messenger app that allows other applications to send messages via a webhook. This functionality is used to allow users to receive alerts about LinuxGSM.
4
4
5
5
## Setup a Telegram Bot
6
6
@@ -75,7 +75,7 @@ Add the chat id to the [LinuxGSM config](../configuration/linuxgsm-config.md).
75
75
The number given is the chat id
76
76
77
77
{% hint style="warning" %}
78
-
A group number includes a dash in the chat id e.g `-191537238`
78
+
A group number might include a dash in the chat id e.g `-191537238`
79
79
{% endhint %}
80
80
81
81
```text
@@ -100,3 +100,7 @@ Finally, test that everything correctly works by sending a test alert. You will
100
100
./gameserver test-alert
101
101
```
102
102
103
+
## Custom cURL String
104
+
105
+
You can add a custom cURL string eg proxy \(useful in Russia\) in "curlcustomstring"
Copy file name to clipboardexpand all lines: configuration/linuxgsm-config.md
+12
Original file line number
Diff line number
Diff line change
@@ -40,6 +40,18 @@ Do not edit \_default.cfg any changes to this file will be overwritten.
40
40
41
41
`instance.cfg` is the configuration file used for each individual game server instance. Settings here will only apply to this specific game server instance. This config file takes the same name as the game server instance name `./gameserver`. For example, if `./csgoserver` is used the _instance.cfg_ will be called `csgoserver.cfg`. This config is last to be loaded.
42
42
43
+
### Secret Configs
44
+
45
+
{% hint style="danger" %}
46
+
Secret configs are not enrypted, but a place to store sensetive info away from other configs.
47
+
{% endhint %}
48
+
49
+
The secret configs are a place to put sensitive information such as steam login details away from the main config files. This is done to allow server admins to backup their configs while excluding sensitive information. This is particularly useful for admins who want to create a version-controlled skeleton configuration using git that they might want to make public.
50
+
51
+
It is important to know that the secret config is NOT encrypted or any more secure than other configs.
52
+
53
+
A secret config can be identified with the word `secrets` prepended to the front of the config name.
54
+
43
55
### Config Load Priority
44
56
45
57
When LinuxGSM is loading the configs they will load in order. First taking settings from `_default.cfg` then `common.cfg` and finally `instance.cfg`. This means that any setting set in `instance.cfg` will override that setting in `common.cfg` which in turn will override the setting in `_default.cfg`.
Copy file name to clipboardexpand all lines: configuration/local-home-server.md
+8
Original file line number
Diff line number
Diff line change
@@ -2,3 +2,11 @@
2
2
3
3
WIP
4
4
5
+
## Home Servers
6
+
7
+
Home servers are a great way to experiment with game servers, for LAN partys or can be used as a permanent option if you have the bandwidth. There are extra steps required on your home router to allow external access to your game server. This will normally involve opening ports on the router firewall and/or port forwarding. See [this link](https://www.howtogeek.com/66214/how-to-forward-ports-on-your-router/) for basic instructions. See your router's manual for specific instructions.
8
+
9
+
### Specifying you IP for Home Server
10
+
11
+
If you want to specify the game server IP address using the `ip=` you will need to set the IP address of the servers LAN interface \(e.g 192.168.1.2\), not your routers external IP. Setting this incorrectly will prevent the game server ports from binding and your server will not start.
Copy file name to clipboardexpand all lines: configuration/ports.md
+42-39
Original file line number
Diff line number
Diff line change
@@ -1,34 +1,34 @@
1
1
# Ports
2
2
3
-
You will need to give attention to ports in multiple cases.
3
+
Ports are communication endpoints for an application. A port will either listen or transmit network traffic on specific ports.
4
4
5
-
Here are the most common ones:
5
+
There are port standards set by IANA for common protocols such as HTTP \(port 80\), SSH \(port 22\), SMTP \(port 25\) etc. Game servers tend to use standard ports depending upon the game engine. For example source engine games by default use port 27015 as the port it listens on.
6
6
7
-
* When you want to run [Multiple Game Servers](../features/multiple-game-servers.md) on the same machine
8
-
* When you have a strict firewall and you need to open the right ports in order to let people connect to your server \(see [Firewalls](../linux/firewalls.md)\)
9
-
* When you need to forward ports on a NAT to the desired local IP in order for your server to be reachable from outside the local network \(likely from the internet\)
7
+
~~Here are the most common ones:~~
10
8
11
-
## Generalities and vocabulary
9
+
*~~When you want to run~~[~~Multiple Game Servers~~](../features/multiple-game-servers.md)~~on the same machine~~
10
+
*~~When you have a strict firewall and you need to open the right ports in order to let people connect to your server \(see~~[~~Firewalls~~](../linux/firewalls.md)~~\)~~
11
+
*~~When you need to forward ports on a NAT to the desired local IP in order for your server to be reachable from outside the local network \(likely from the internet\)~~
12
12
13
-
*`Port listening` is what a service like a game server does in order to receive packets from incoming connections: by listening to a port, the program waiting for incoming packets on a given port.
14
-
*`Port redirection` happens on a router, in the NAT part \(can also be done using iptables, but unlikely what you are looking for\): it consists in forwarding incoming traffic on a given port to a specific local \(regarding the router\) IP.
15
-
*`Port opening` happens on a firewall, it consists in allowing traffic to a port.
16
-
* The IP variable `ip=` always needs to be the server interface IP, not your routers external IP: a service on a server can only listen on a local IP that is present on an interface of the hosting machine.
17
-
* In order to `run multiple game servers` on the same machine, you need to make sure they all use different ports, or if your server has multiple public IPs, that they are bound to different IPs.
13
+
## Vocabulary
18
14
19
-
## Setting ports
15
+
*_**Port listening**_****is what a service like a game server does in order to receive packets from incoming connections: by listening to a port, the program waiting for incoming packets on a given port.
16
+
*_**Port opening**_ happens on a firewall, it consists of allowing traffic to a port.
17
+
*_**Port redirection**_ is part of NAT and happens on a router or firewall. It consists of forwarding incoming traffic on a given port to a specific local IP.
18
+
*_**Network Address Translation \(NAT\)**_ is a method of remapping an IP address into another by modifying [network address](https://en.wikipedia.org/wiki/Network_address) information.
20
19
21
-
Listening ports are usually set within your start parameters, sometimes in the game server config file.
20
+
## Game Server Ports
22
21
23
-
For info about start parameters, see [Start Parameters](start-parameters.md) and [LinuxGSM Config](linuxgsm-config.md) For info about your game server config, see [Game Server Config](game-server-config.md).
22
+
Game Servers typicaliy have ports for the following functions.
24
23
25
-
## View current settings
24
+
Game port: The port that players connect to.
25
+
Query port: Used by software to gather information from the server such as server name, map and number of players.
26
+
Rcon port
27
+
Web port: used for game server that have web admin panels
26
28
27
-
To view your current server ports, input:
29
+
Depending upon which game server being used, you can set game server ports within your start parameters or game server config file.
28
30
29
-
`./gameserver details`
30
-
31
-
Example output sample:
31
+
LinuxGSM allows you to see the ports your game server is using with the `./gameserver details` command.
32
32
33
33
```text
34
34
Useful port diagnostic command:
@@ -40,9 +40,11 @@ DESCRIPTION DIRECTION PORT PROTOCOL
40
40
< Client OUTBOUND 27002 udp
41
41
```
42
42
43
-
## Changing default ports
43
+
## Changing Default Ports
44
+
45
+
Default ports are set in either the [start parameters](start-parameters.md) or [game config](game-server-config.md).
44
46
45
-
Default ports are set in either the start parameters or game config. You can use `./gameserver details` to find out where to edit port settings
47
+
LinuxGSMYou can use `./gameserver details` to find out where to edit port settings
46
48
47
49
```text
48
50
# Ports
@@ -65,23 +67,15 @@ ip="0.0.0.0"
65
67
66
68
### Which ports can be used?
67
69
68
-
You can use any port as long as it is not already in use and it is up to admins how to setup port allocation. It is recommended that ports are close together and sequential i.e 27015,27016,27017 to save confusion. Some servers ports by default are not sequential, however, there is nothing stopping an admin from changing this. Example for source servers; you could set the port 27015, sourcetv port 27016, client port 27018. The next game server instance could simply follow on from this.
70
+
You can use any port as long as it is not already in use and it is up to you to set up port allocation. It is recommended that ports are close together and sequential i.e 27015,27016,27017 to save confusion. Some servers ports by default are not sequential, however, there is nothing stopping you from changing this. Example for source engine game servers; you could set the port 27015, source tv port 27016, client port 27018. The next game server instance could simply follow on from this.
69
71
70
-
> Reminder: If you're running several servers, make sure you're using different ports on all of your servers.
72
+
{% hint style="info" %}
73
+
If you're running multiple game servers, make sure you're using different ports on all of your game servers to avoid a port conflict.
74
+
{% endhint %}
71
75
72
76
## Multiple IP addresses
73
77
74
-
Should a server has multiple dedicated IP addresses allocated, it is possible for game servers to have the same ports but bound to the different IP addresses. Admins will need to set the specific IP address in the LinuxGSM config or game config.
75
-
76
-
## Home Servers
77
-
78
-
Home servers are a great way to experiment with game servers or can be used as a permanent option if you have the bandwidth. There are extra steps required on your home router to allow external access to your game server. This will normally involve opening ports on the router firewall and/or port forwarding. See [this link](https://www.howtogeek.com/66214/how-to-forward-ports-on-your-router/) for basic instuctions. See your router's manual for specific instructions.
79
-
80
-
### ip= setting for home servers
81
-
82
-
If your server has multiple interfaces you will be prompted to specify the server IP you want to use.
83
-
84
-
You will need to set the IP address of the servers LAN interface \(e.g 192.168.1.2\), not your routers external IP. Setting this incorrectly will prevent the game server ports from binding and your server will not start.
78
+
Should a server have multiple dedicated IP addresses allocated, it is possible for game servers to have the same ports but bound to the different IP addresses. Admins will need to set the specific IP address in the LinuxGSM config or game config.
85
79
86
80
## Port Allocation Scheme
87
81
@@ -133,20 +127,29 @@ You can get new IP addresses for your dedicated server, and assign each server a
133
127
134
128
If you are running several game servers it is a good idea to create a spreadsheet of the ports you have used. Allowing you to keep track of what you have already used.
135
129
136
-
### Diagnosing server accessibility
130
+
## Diagnosing server accessibility
131
+
132
+
### Check port are bound
137
133
138
-
1\)Ensure the game server ports are bound and listening Before anything else, you need to know if your server is actually listening. Input : `./gameserver details` and look for this kind of diagnose command:
134
+
Ensure the game server ports are bound and listening before anything else, you need to know if your server is actually listening. Input : `./gameserver details` and look for this kind of diagnose command:
139
135
140
136
```text
141
137
Useful port diagnostic command:
142
138
netstat -atunp | grep srcds_linux
143
139
```
144
140
145
-
Running the command will bring up any ports that are listening. If not, the server has not started or not correcting binding to its allocated ports. Check that ports are not already in use by something else. Check that you are trying to listen to an actual interface IP, check that ports are not already in use by another application, check that the server does not crash upon start by checking console logs or try starting the server with `./gameserver debug`
141
+
Running the command will bring up any ports that are listening. If not, the game server has not started or not correctly binding to its allocated ports.
142
+
143
+
* Check that ports are not already in use by something else.
144
+
* Check that you are trying to listen to an actual interface IP.
145
+
* Check that ports are not already in use by another application.
146
+
* check that the server does not crash upon start by checking console logs or try starting the server with `./gameserver debug`
147
+
148
+
### Check the Firewall
146
149
147
-
2\) Check the Firewall
148
150
[Firewalls](../linux/firewalls.md) are a regular source of connectivity issues. When diagnosing connection issues temporarily disabling a firewall will help identify if it is the source of the problem.
149
151
150
-
3\) Check Port Forwarding \(local networks only\)
152
+
### Check Port Forwarding \(Local Networks\)
153
+
151
154
Ensure that the router correctly redirects incoming traffic to the correct ports and local IP displayed with `./gameserver details` with the correct protocol \(TCP and/or UDP\).
Copy file name to clipboardexpand all lines: game-servers/README.md
+2-3
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Game Servers
2
2
3
-
LinuxGSM cannot always provide support for specific game servers. However there are various support forums available for specific game server support that may be useful. Below is a list of useful links support forums:
3
+
LinuxGSM cannot always provide support for specific game servers. However, there are various support forums available for specific game server support that may be useful. Below is a list of useful links support forums:
0 commit comments