From d19e2111716c06417c1c28c96fc7771d4ac23281 Mon Sep 17 00:00:00 2001 From: NoCatt <86153630+NoCatt@users.noreply.github.com> Date: Mon, 2 Oct 2023 15:30:56 +0200 Subject: Change prerequisites page to "getting started" (#225) This should hopefully make novices more likely to check out this page before trying to set up a server. --- docs/SUMMARY.md | 2 +- docs/faq.md | 4 +- .../getting-started.md | 62 ++++++++++++++++++++++ .../prerequisites.md | 62 ---------------------- .../troubleshooting.md | 2 +- 5 files changed, 66 insertions(+), 66 deletions(-) create mode 100644 docs/hosting-a-server-with-northstar/getting-started.md delete mode 100644 docs/hosting-a-server-with-northstar/prerequisites.md (limited to 'docs') diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index f1fbaae..f5bcd4f 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -32,7 +32,7 @@ ## Hosting a server with Northstar -* [Prerequisites](hosting-a-server-with-northstar/prerequisites.md) +* [Getting started](hosting-a-server-with-northstar/getting-started.md) * [Hosting a Basic Listen Server](hosting-a-server-with-northstar/basic-listen-server.md) * [Hosting a Dedicated Server](hosting-a-server-with-northstar/dedicated-server/README.md) * [Best practices](hosting-a-server-with-northstar/dedicated-server/best-practices.md) diff --git a/docs/faq.md b/docs/faq.md index 54c9207..96506cb 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -42,8 +42,8 @@ A: Due to the way Northstar works, you sadly cannot just create a private match Check the prerequisites: -{% content-ref url="hosting-a-server-with-northstar/prerequisites.md" %} -[prerequisites.md](hosting-a-server-with-northstar/prerequisites.md) +{% content-ref url="hosting-a-server-with-northstar/getting-started.md" %} +[getting-started.md](hosting-a-server-with-northstar/getting-started.md) {% endcontent-ref %} and instructions to host a _listen server_: diff --git a/docs/hosting-a-server-with-northstar/getting-started.md b/docs/hosting-a-server-with-northstar/getting-started.md new file mode 100644 index 0000000..9bd8177 --- /dev/null +++ b/docs/hosting-a-server-with-northstar/getting-started.md @@ -0,0 +1,62 @@ +# Getting started + +**TL;DR:** Port forward `37015` (UDP), and no [CGNAT](getting-started.md#cgnat) + +Make sure you already installed Northstar [as described here](../installing-northstar/basic-setup.md). + +{% hint style="warning" %} +Hosting your own server of any kind requires basic knowledge of computer networks!\ +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 + +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). + +An explanation of what port-forwarding is exactly can be found in the following video: + +{% embed url="https://www.youtube.com/watch?v=WOZQppVNGvA" %} + +## CGNAT + +First we want to make sure you're not behind a [CGNAT](https://en.wikipedia.org/wiki/Carrier-grade\_NAT) as this basically means you [won't be able to host at all](https://en.wikipedia.org/wiki/Carrier-grade_NAT#Disadvantages). + +For this find out your external IP address [by visiting this site](https://www.whatsmyip.org). + +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 +``` + +if only your external IP address shows up when the commands exits you're good. + +If you get 2 entries or more you're likely behind a [CGNAT](https://en.wikipedia.org/wiki/Carrier-grade\_NAT). Your only options in this case are either to ask your ISP to give you a public IP address or check whether at least your IPv6 address is public. + +## Port forwarding + +Access your router via it's web interface and port forward + +* `37015` (UDP) for game logic + +to your PC that you're running Northstar on. + +## Firewall + +You need to allow the `NorthstarLauncher.exe` in the firewall so that it can connect to the internet. By default, when you launch the server, it should pop up the Windows security alert and let you decide if the application able to connect to the network. + +If you accidentally click the deny button, then follow the step to allow it. + +* Open Windows Firewall +* Select "Allow an app or feature through Windows Defender Firewall" +* Click "Allow other applications" +* Click "Browse" +* Locate `NorthstarLauncher.exe` and select it +* Click "Add" + +## Final checks + +To check whether you set everything up correctly, start the game via Northstar and go into a private match. Another Northstar user should now be able to see your server on the server browser and join it.\ +You can also use a web based server browser like the one made by [Taskinoz](https://taskinoz.com/northstar/) or [cpdt](https://cpdt.dev/northstar/) to see if your server shows up in there. + +Note that by default your server is called `Unnamed Northstar Server`. You can change this name as described in the next page. diff --git a/docs/hosting-a-server-with-northstar/prerequisites.md b/docs/hosting-a-server-with-northstar/prerequisites.md deleted file mode 100644 index ff6df73..0000000 --- a/docs/hosting-a-server-with-northstar/prerequisites.md +++ /dev/null @@ -1,62 +0,0 @@ -# Prerequisites - -**TL;DR:** Port forward `37015` (UDP), and no [CGNAT](prerequisites.md#cgnat) - -Make sure you already installed Northstar [as described here](../installing-northstar/basic-setup.md). - -{% hint style="warning" %} -Hosting your own server of any kind requires basic knowledge of computer networks!\ -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 - -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). - -An explanation of what port-forwarding is exactly can be found in the following video: - -{% embed url="https://www.youtube.com/watch?v=WOZQppVNGvA" %} - -## CGNAT - -First we want to make sure you're not behind a [CGNAT](https://en.wikipedia.org/wiki/Carrier-grade\_NAT) as this basically means you [won't be able to host at all](https://en.wikipedia.org/wiki/Carrier-grade_NAT#Disadvantages). - -For this find out your external IP address [by visiting this site](https://www.whatsmyip.org). - -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 -``` - -if only your external IP address shows up when the commands exits you're good. - -If you get 2 entries or more you're likely behind a [CGNAT](https://en.wikipedia.org/wiki/Carrier-grade\_NAT). Your only options in this case are either to ask your ISP to give you a public IP address or check whether at least your IPv6 address is public. - -## Port forwarding - -Access your router via it's web interface and port forward - -* `37015` (UDP) for game logic - -to your PC that you're running Northstar on. - -## Firewall - -You need to allow the `NorthstarLauncher.exe` in the firewall so that it can connect to the internet. By default, when you launch the server, it should pop up the Windows security alert and let you decide if the application able to connect to the network. - -If you accidentally click the deny button, then follow the step to allow it. - -* Open Windows Firewall -* Select "Allow an app or feature through Windows Defender Firewall" -* Click "Allow other applications" -* Click "Browse" -* Locate `NorthstarLauncher.exe` and select it -* Click "Add" - -## Final checks - -To check whether you set everything up correctly, start the game via Northstar and go into a private match. Another Northstar user should now be able to see your server on the server browser and join it.\ -You can also use a web based server browser like the one made by [Taskinoz](https://taskinoz.com/northstar/) or [cpdt](https://cpdt.dev/northstar/) to see if your server shows up in there. - -Note that by default your server is called `Unnamed Northstar Server`. You can change this name as described in the next page. diff --git a/docs/hosting-a-server-with-northstar/troubleshooting.md b/docs/hosting-a-server-with-northstar/troubleshooting.md index cd35be9..d1f06ea 100644 --- a/docs/hosting-a-server-with-northstar/troubleshooting.md +++ b/docs/hosting-a-server-with-northstar/troubleshooting.md @@ -42,7 +42,7 @@ If your port can be accessed from your local IP but not from your public IP, the **CGNAT** -See [CGNAT](https://r2northstar.gitbook.io/r2northstar-wiki/hosting-a-server-with-northstar/prerequisites#cgnat) +See [CGNAT](https://r2northstar.gitbook.io/r2northstar-wiki/hosting-a-server-with-northstar/getting-started#cgnat) ### If server is not reachable using external IP nor using internal IP -- cgit v1.2.3