Fixes #71, improved configuration documentation

diff --git a/docs/Running-the-server.md b/docs/Running-the-server.md
index d948a4875f7bcb362fadb453502e8a92abc2f45a..0a30b02b3104f1e3fe5670817de567dce5083c63 100644 (file)
--- a/docs/Running-the-server.md
+++ b/docs/Running-the-server.md
@@ -74,8 +74,8 @@ Example configuration:
     "ListenPort": 22024
   },
   "ServerRedirector": {
-    "Enabled": false,
-    "Master": true,
+    "Enabled": true,
+    "Master": false,
     "Locator": {
       "Redis": "",
       "UdpMasterEndpoint": "127.0.0.1:22023"

diff --git a/docs/Server-configuration.md b/docs/Server-configuration.md
index 1205d06f8dce4531290288225cb824fa9720b767..2896b234f0c9375465f8c1fba7d19d0c37ff2b5a 100644 (file)
--- a/docs/Server-configuration.md
+++ b/docs/Server-configuration.md
@@ -6,7 +6,7 @@ Some information about all the possible configurations. Click [here](https://git
 
 ### File
 
-The simplest option to configure is by using the `config.json` file next to the server executable.
+The simplest option to configure is by using the `config.json` file next to the server executable. For all possible options see the [config-full.json](https://github.com/Impostor/Impostor/blob/dev/src/Impostor.Server/config-full.json) file.
 
 ### Command line arguments
 
@@ -16,7 +16,7 @@ TODO
 Server:PublicIp=127.0.0.1
 Server:PublicPort=22023
 Server:ListenIp=0.0.0.0
-Server:listenPort=22023
+Server:ListenPort=22023
 AntiCheat:BanIpFromGame=true
 ServerRedirector:Enabled=false
 ServerRedirector:Master=true
@@ -36,7 +36,7 @@ TODO
 IMPOSTOR_Server__PublicIp=127.0.0.1
 IMPOSTOR_Server__PublicPort=22023
 IMPOSTOR_Server__ListenIp=0.0.0.0
-IMPOSTOR_Server__listenPort=22023
+IMPOSTOR_Server__ListenPort=22023
 IMPOSTOR_AntiCheat__BanIpFromGame=true
 IMPOSTOR_ServerRedirector__Enabled=false
 IMPOSTOR_ServerRedirector__Master=true
@@ -50,4 +50,28 @@ IMPOSTOR_ServerRedirector__Nodes__1__Port=22025
 
 ## Options
 
-TODO - Write something about every option.
\ No newline at end of file
+### Server
+
+| Key | Default | Description |
+|-|-|-|
+| **PublicIp** | `127.0.0.1` | This needs to the IPv4 address of the server, what you give to others to connect. You can find the your IPv4 address [here](http://whatismyip.host/). |
+| **PublicPort** | `22023` | The public port of the server, what you give to others to  connect. Usually `22023`. |
+| **ListenIp** | `0.0.0.0` | The network interface to listen on. If you do not know what to put here, use `0.0.0.0`. |
+| **ListenPort** | `22023` | The listen port of the server, usually `22023`. |
+
+### AntiCheat
+
+| Key | Default | Value |
+|-|-|-|
+| **BanIpFromGame** | `true` | When a player is caught hacking, he will be kicked from the server. If this value is set to `true`, the player will also be banned and can not rejoin that specific game. |
+
+### ServerRedirector
+
+| Key | Default | Value |
+|-|-|-|
+| **Enabled** | `false` | Whether the server runs in multi-node setup. If this is `false`, all other options in this section do not have any effect. |
+| **Master** | `false` | Whether the current server is a master. A master is responsible for redirecting clients to nodes |
+| **Locator** | | Fill in either `Redis` or `UdpMasterEndpoint` to choose which method to use for locating other nodes. This must be the same across all servers. |
+| **>Redis** | | Format `127.0.0.1.6379`, you can also use a password like so: `127.0.0.1.6379,password=value`. |
+| **>UdpMasterEndpoint** | | On the master, this value acts as a listen ip and port. On a node, this should be the public ip and port of the master. Format `127.0.0.1:32320`. |
+| **Nodes** | | An array containing public ips and ports of nodes. Only needs to be set on the master. See above for an example. |
\ No newline at end of file