From 5869a4756d32f54313e99c613899cfa3acf1187a Mon Sep 17 00:00:00 2001 From: pg9182 <96569817+pg9182@users.noreply.github.com> Date: Wed, 26 Apr 2023 11:50:45 -0400 Subject: Update docs for Northstar v1.13 UDP auth (#158) --- .../basic-listen-server.md | 6 ++-- .../dedicated-server/README.md | 4 +-- .../dedicated-server/hosting-on-linux.md | 6 ++-- .../prerequisites.md | 4 +-- .../troubleshooting.md | 33 ++++++---------------- 5 files changed, 20 insertions(+), 33 deletions(-) diff --git a/docs/hosting-a-server-with-northstar/basic-listen-server.md b/docs/hosting-a-server-with-northstar/basic-listen-server.md index 692094b..f3df3a0 100644 --- a/docs/hosting-a-server-with-northstar/basic-listen-server.md +++ b/docs/hosting-a-server-with-northstar/basic-listen-server.md @@ -2,8 +2,8 @@ ## Instructions -To host a listen server on Northstar, go to the lobby and press the `Private Match` button to begin a private match. While this does allow you to host a server, other people won't be able to join it, so you'll need to port forward 2 ports to allow other people to join.\ -The ports you'll need to forward are `37015` UDP, and `8081` TCP by default, if this works as it should, this should result in your server being displayed on the server browser, and other clients being able to connect to it.\ +To host a listen server on Northstar, go to the lobby and press the `Private Match` button to begin a private match. While this does allow you to host a server, other people won't be able to join it, so you'll need to port forward UDP port `37015` to allow other people to join.\ +On Northstar v1.12 and older, you'll need to also forward TCP port `8081`. If this works correctly, this should result in your server being displayed on the server browser, and other clients being able to connect to it.\ ![screenshot select private match](https://raw.githubusercontent.com/R2Northstar/NorthstarWiki/main/docs/images/lobbyprivatematch.png) ## Server Configuration @@ -26,7 +26,7 @@ Below are a series of variables and commands you can use for server configuratio | `ns_report_sp_server_to_masterserver` | Whether your server should report itself to the masterserver if started on a singleplayer map, for use in auth and the serverbrowser | `0` | | `ns_auth_allow_insecure` | Allows clients to join your server without authenticating with the masterserver, currently required to allow clients to connect directly to your IP, rather than through the server browser | `0` | | `ns_erase_auth_info` | Whether your server should erase authentication information after it is used, this is useful for development but should normally be kept at 1 | `1` | -| `ns_player_auth_port` | The port used for the server's local authentication server, this is the TCP port we forwarded earlier | `8081` | +| `ns_player_auth_port` | Northstar v1.12 and older only. The port used for the server's local authentication server, this is the TCP port we forwarded earlier | `8081` | | `everything_unlocked` | Whether all items, weapons, etc should be unlocked on the server | `1` | | `ns_should_return_to_lobby` | Whether the server should return to private match lobby after completing a game, if 0, this will go to the next map/mode in the playlist | `1` | | `ns_private_match_only_host_can_change_settings` | If 0 Players can change all match settings. If 1 Players can only change map and gamemode. If 2 Players can change nothing | `0` | diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/README.md b/docs/hosting-a-server-with-northstar/dedicated-server/README.md index d0eb059..969a8aa 100644 --- a/docs/hosting-a-server-with-northstar/dedicated-server/README.md +++ b/docs/hosting-a-server-with-northstar/dedicated-server/README.md @@ -111,7 +111,7 @@ Example: `+setplaylistvaroverrides "run_epilogue 0 featured_mode_amped_tacticals Convars are located inside the `R2Northstar\mods\Northstar.CustomServers\mod\cfg\autoexec_ns_server.cfg` file. -They allow the server admin to set server's properties like the name, TCP port, and description. +They allow the server admin to set server's properties like the name, port, and description. | Name | Description | Default Value | Accepted Values | | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -------------------------------------------------- | @@ -122,7 +122,7 @@ They allow the server admin to set server's properties like the name, TCP port, | `ns_report_sp_server_to_masterserver` | Whether your server should report itself to the masterserver if started on a singleplayer map, for use in auth and the serverbrowser | `0` | `0-1` | | `ns_auth_allow_insecure` | Allows clients to join your server without authenticating with the masterserver, currently required to allow clients to connect directly to your IP, rather than through the server browser | `0` | `0-1` | | `ns_erase_auth_info` | Whether your server should erase authentication information after it is used, this is useful for development but should normally be kept at 1 | `1` | `0-1` | -| `ns_player_auth_port` | The port used for the server's local authentication server, this is the TCP port we forwarded earlier | `8081` | `1-65535` | +| `ns_player_auth_port` | Northstar v1.12 and older only. The port used for the server's local authentication server, this is the TCP port we forwarded earlier | `8081` | `1-65535` | | `everything_unlocked` | Whether all items, weapons, etc should be unlocked on the server | `1` | `0-1` | | `ns_should_return_to_lobby` | Whether the server should return to private match lobby after completing a game, if 0, this will go to the next map/mode in the playlist | `1` | `0-1` | | `ns_private_match_only_host_can_change_settings` | If 0 Players can change all match settings. If 1 Players can only change map and gamemode. If 2 Players can change nothing | `0` | `0-2` | diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md b/docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md index b8bd2c0..caffec9 100644 --- a/docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md +++ b/docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md @@ -68,7 +68,8 @@ services: pull_policy: always environment: NS_PORT: 37015 - NS_PORT_AUTH: 8081 + # uncomment for Northstar v1.12 and older + #NS_PORT_AUTH: 8081 NS_SERVER_NAME: "Enter Server Name here" NS_SERVER_DESC: "Enter your description here" NS_EXTRA_ARGUMENTS: | @@ -86,7 +87,8 @@ services: - /home/YOUR_USERNAME_HERE/Titanfall2/mods:/mnt/mods:ro ports: - "37015:37015/udp" - - "8081:8081/tcp" + # uncomment for Northstar v1.12 and older + #- "8081:8081/tcp" restart: always ``` diff --git a/docs/hosting-a-server-with-northstar/prerequisites.md b/docs/hosting-a-server-with-northstar/prerequisites.md index 72c72bf..7d2456d 100644 --- a/docs/hosting-a-server-with-northstar/prerequisites.md +++ b/docs/hosting-a-server-with-northstar/prerequisites.md @@ -1,6 +1,6 @@ # Prerequisites -**TL;DR:** Port forward `37015` (UDP) and `8081` (TCP) +**TL;DR:** Port forward `37015` (UDP). If using Northstar v1.12 or older, also port forward `8081` (TCP). Make sure you already installed Northstar [as described here](../installing-northstar/basic-setup.md). @@ -38,7 +38,7 @@ If you get 2 entries or more you're likely behind a [CGNAT](https://en.wikipedia Access your router via it's web interface and port forward * `37015` (UDP) for game logic -* `8081` (TCP) for Northstar auth so your server shows up in server browser +* `8081` (TCP) for Northstar auth on Northstar v1.12 and older so your server shows up in server browser to your PC that you're running Northstar on. diff --git a/docs/hosting-a-server-with-northstar/troubleshooting.md b/docs/hosting-a-server-with-northstar/troubleshooting.md index d258392..27e5569 100644 --- a/docs/hosting-a-server-with-northstar/troubleshooting.md +++ b/docs/hosting-a-server-with-northstar/troubleshooting.md @@ -1,22 +1,5 @@ # Troubleshooting -## 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. -This error means that masterserver can't access your server's tcp port. - -Multiple problems can cause this error, but you can narrow it down by checking if your server is reachable from the outside. - -### Check if server is reachable - -You can check if the server is reachable using your internet browser. - -example : `http://{server_ip}:{server_tcp_port}/verify` should answer you `I am a northstar server!` - -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** @@ -31,9 +14,9 @@ Check Northstar's Discord for annoucements. **Ports are not the same** -Your gameserver is configured to listen to a given TCP port. +Your gameserver is configured to listen to a given UDP port. -Masterserver needs to be able to contact your gameserver though that same port. +Masterserver needs to be able to contact your gameserver though that same port (i.e., you can't forward a different external port). **Another Northstar Server is using the port** @@ -45,11 +28,11 @@ 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 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. -Disabling the firewall and antivirus can also work, even if it's not reccomended. +Disabling the firewall and antivirus can also work, even if it's not recommended. ### If server is not reachable using external IP but reachable using internal IP @@ -67,15 +50,17 @@ Try checking your loopback network interface `http://127.0.0.1:{server_tcp_port} **Another program is using the port** -Sometimes another program listens to the same tcp port as Northstar. +Sometimes another program listens to the same port as Northstar. 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. +As two programs cannot listen to the same port and IP at the same time, changing the listen port can sometimes solve the problem. **Server is using the wrong port** -You can use `netstat -a -b` using CMD as admin to check which process listens on which port +If you are running multiple instances, the other instances may use a higher port number automatically. + +You can use `netstat -a -b` using CMD as admin to check which process listens on which port. ## Cannot join own dedicated server via serverbrowser but others can -- cgit v1.2.3