aboutsummaryrefslogtreecommitdiff
path: root/docs/hosting-a-server-with-northstar
diff options
context:
space:
mode:
authoramione <57235791+xamionex@users.noreply.github.com>2022-02-04 16:16:50 +0100
committerGitHub <noreply@github.com>2022-02-04 16:16:50 +0100
commit1ecd37b2ef1f68abccb686a2f7cb0bdd1802cb14 (patch)
treea0014d0c255643e9c841606d97596918141802ab /docs/hosting-a-server-with-northstar
parentcddf675463573c38b5e93926825ab438fc796eaf (diff)
downloadNorthstarWiki-1ecd37b2ef1f68abccb686a2f7cb0bdd1802cb14.tar.gz
NorthstarWiki-1ecd37b2ef1f68abccb686a2f7cb0bdd1802cb14.zip
Updating Wiki Stuff (#39)
* add more issues so people don't ask over and over * fix improper indentation * MD026/no-trailing-punctuation * remove issues from faq and link to troubleshooting * MD001/heading-increment * fulfill* * MD032/blanks-around-lists * MD001/heading-increment * MD033/no-inline-html * revert MD Rule (not sure what this <a> is used for * me when i didnt mean to do that * use da link and also when the... what * bin folder * Formatting Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> * Formatting Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> * fix intel link * MD034/no-bare-urls: Bare URL used * MD045/no-alt-text * MD012/no-multiple-blanks * I know this is unused, just wanted to write smth * fix links * add tools * please stop using real urls. you have markdown. * modding tools * add tools * no actual urls <3 * fix tools link * does this look better? * nope * remove "some stuff" * better formatting * oops * oops v2 * GitBook: [#1] No subject * i didnt create this * MD Rules * Update docs/modding/tools.md Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> * Update docs/modding/README.md Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> * move mtools down * change vtfedit * rem tools * no winrar. bad. * non-shortened url * add kvals to summary Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>
Diffstat (limited to 'docs/hosting-a-server-with-northstar')
-rw-r--r--docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md7
-rw-r--r--docs/hosting-a-server-with-northstar/prerequisites.md4
-rw-r--r--docs/hosting-a-server-with-northstar/troubleshooting.md22
3 files changed, 15 insertions, 18 deletions
diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md b/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md
index 834ff77..6128d5c 100644
--- a/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md
+++ b/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md
@@ -4,7 +4,6 @@ description: Tweaks and tricks to improve both your experience in hosting and ot
# Best practices
-
{% hint style="info" %}
TODO: If you have experience in hosting Northstar servers and want to share your knowledge, please open a [pull request](https://github.com/R2Northstar/NorthstarWiki/pulls).
{% endhint %}
@@ -17,14 +16,12 @@ The current minimum requirements are as follows:
- 5GB free disk space (+3 GB if you're on windows due to origin and deps)
- 3+ cores (2 might work, though)
-- 6GB+ total memory (RAM or swap will do)
-- Windows 8.1 (and built-in WARP [use `-softwared3d11`] or a graphics card) + or wine 6.0.0+ (and dxvk+lavapipe+x11, wined3d+llvmpipe+x11, or a working graphics setup with dxvk or llvmpipe) (see https://git.io/JyrOR for wine details)
-
+- 6GB+ total memory (RAM or swap will do)
+- Windows 8.1 (and built-in WARP [use `-softwared3d11`] or a graphics card) + or wine 6.0.0+ (and dxvk+lavapipe+x11, wined3d+llvmpipe+x11, or a working graphics setup with dxvk or llvmpipe) (see [this](https://github.com/pg9182/northstar-dedicated) for more)
**Per instance:**
- 2GB RAM (this is what's actually used; it does drop to ~1.2GB after a bit)
- 15 Mbps network upload, but 10 is workable, 25 if you want to avoid players getting disconnected when going back to the lobby after a match
-
**Note:** It is recommended to surpass the listed requirements. Currently the number of available servers covers the daily playerbase more than enough. If you're planning to host public servers for the community it is therefore recommended to either fill a niche (like a gamemode that is so popular that all existing servers are full) or provide a better service than existing hosts (less lag, more stable, etc.).
diff --git a/docs/hosting-a-server-with-northstar/prerequisites.md b/docs/hosting-a-server-with-northstar/prerequisites.md
index ce2cdd2..4448352 100644
--- a/docs/hosting-a-server-with-northstar/prerequisites.md
+++ b/docs/hosting-a-server-with-northstar/prerequisites.md
@@ -9,7 +9,7 @@ Hosting your own server of any kind requires basic knowledge of computer network
If you for example don't know what "port forwarding" means and just want to play private matches with your friends it is generally recommended to just find an empty public server instead of trying to host your own server.
{% endhint %}
-## Check whether you can port forward:
+## Check whether you can port forward
In order for others to join your game they need to be able to reach you. Most likely your router acts as a NAT so you need to port forward two ports to your PC for [NAT traversal](https://en.wikipedia.org/wiki/NAT\_traversal).
@@ -21,7 +21,7 @@ For this find out your external IP address [by visiting this site](https://www.w
Then [open CMD](https://www.lifewire.com/how-to-open-command-prompt-2618089#toc-open-command-prompt-in-windows-10) and type in:
-```
+```txt
tracert <your external IP address here>
```
diff --git a/docs/hosting-a-server-with-northstar/troubleshooting.md b/docs/hosting-a-server-with-northstar/troubleshooting.md
index c4f7ea0..847e836 100644
--- a/docs/hosting-a-server-with-northstar/troubleshooting.md
+++ b/docs/hosting-a-server-with-northstar/troubleshooting.md
@@ -1,4 +1,5 @@
# Document is empty
+
`[error] Failed reading masterserver authentification response: encountered parse error 'The document is empty.'`
Masterserver needs to request your gameserver for it to be authentified and registered.
@@ -16,23 +17,23 @@ Your server **must** be running while you check if the server is reachable.
## If server is reachable using external IP
-#### Your GameServer is out of date
+### Your GameServer is out of date
Check that your server is running on the latest Northstar release as it can sometimes include breaking changes.
-#### Mastserver is down
+### MasterServer is down
Check Northstar's Discord for annoucements.
-https://northstar.tf giving you a HTTP 523 error means that the masterserver is offline.
+[https://northstar.tf](https://northstar.tf) giving you a HTTP 523 error means that the masterserver is offline.
-#### Ports are not the same
+### Ports are not the same
Your gameserver is configured to listen to a given TCP port.
Masterserver needs to be able to contact your gameserver though that same port.
-#### Another Northstar Server is using the port
+### Another Northstar Server is using the port
Shutdown every other server to narrow down the problem
@@ -42,7 +43,7 @@ This won't generally help but will allow you to avoid checking for the wrong ser
Check if your server is reachable from your internal network's IP (often starts with `192.168.x.x`)
-#### Firewall is blocking tcp ports
+### Firewall is blocking tcp ports
In some cases your Firewall or antivirus can prevent your ports to be exposed to your local network.
To fix this issue, make a rule to allow your server to listen on your network.
@@ -50,20 +51,19 @@ Disabling the firewall and antivirus can also work, even if it's not reccomended
## If server is not reachable using external IP but reachable using internal IP
-#### Router configuration is incorrect
+### Router configuration is incorrect
If your port can be accessed from your local IP but not from your public IP, then it's very likely that your NAT rules aren't properly configured.
-#### CGNAT
+### CGNAT
See [CGNAT](https://r2northstar.gitbook.io/r2northstar-wiki/hosting-a-server-with-northstar/prerequisites#cgnat)
-
## If server is not reachable using external IP nor using internal IP
Try checking your loopback network interface `http://127.0.0.1:{server_tcp_port}/verify`
-#### Another program is using the port
+### Another program is using the port
Sometimes another program listens to the same tcp port as Northstar.
@@ -71,6 +71,6 @@ You can check if that's the case by running `netstat -a -b` using CMD as admin
As two programs cannot listen to the same port and IP at the same time, changing the TCP listen port can sometimes solve the problem.
-#### Server is using the wrong port
+### Server is using the wrong port
You can use `netstat -a -b` using CMD as admin to check which process listens on which port