diff options
Diffstat (limited to 'docs/development/northstarmasterserver')
| -rw-r--r-- | docs/development/northstarmasterserver/README.md | 15 | ||||
| -rw-r--r-- | docs/development/northstarmasterserver/deploy.md | 27 |
2 files changed, 42 insertions, 0 deletions
diff --git a/docs/development/northstarmasterserver/README.md b/docs/development/northstarmasterserver/README.md new file mode 100644 index 0000000..d6c94b5 --- /dev/null +++ b/docs/development/northstarmasterserver/README.md @@ -0,0 +1,15 @@ +# NorthstarMasterServer + +{% hint style="warning" %} +The old NodeJS master server has been replaced in favour of the Go rewrite called Atlas. +{% endhint %} + +## Introduction + +The master server is responsible for centralizing game servers created by players, it also verifies that connecting players own an Origin account with Titanfall 2. + +There's no need to host your own master server to play games with other people, you can use [direct connect](../../using-northstar/direct-connect.md) or just setup a [normal server](../../hosting-a-server-with-northstar/basic-listen-server.md) that announces itself to `northstar.tf`. This tutorial is aimed for those who want to contribute improvements to the code or test their own changes to the project. + +## Contents + +* [Deploy](deploy.md) diff --git a/docs/development/northstarmasterserver/deploy.md b/docs/development/northstarmasterserver/deploy.md new file mode 100644 index 0000000..c384730 --- /dev/null +++ b/docs/development/northstarmasterserver/deploy.md @@ -0,0 +1,27 @@ +# Deploy + +## Development + +A Development Master Server uses http requests, it should be used for development purposes on your local machine. + +### Installation steps + +1. Clone [NorthstarMasterServer](https://github.com/R2Northstar/NorthstarMasterServer). +2. Copy the default [dev.env](https://github.com/R2Northstar/NorthstarMasterServer/blob/main/dev.env) to `.env` replace the ip with `127.0.0.1`. +3. Run `npm install` && `npm run watch`. + +Your master server is now running, to connect to it you need to change some configuration files. + +Northstar default masterserver is https://northstar.tf, to point to a new location you need to modify this URL in the `autoexec_ns_server.cfg` and `autoexec_ns_client.cfg` config files. + +### Enabling HTTPS + +HTTPS should be used if you plan for other people to use your master server. It can be enabled pretty easy with [Caddy](https://caddyserver.com/). Download a Caddy binary and create a `Caddyfile` with the following content: + +``` +{$SHORTDOMAIN:localhost} { + reverse_proxy http://127.0.0.1:8080 +} +``` + +After configuring your DNS domain you can run it with `SHORTDOMAIN=example.com caddy run`. Caddy will automatically generate and maintain your certificates for you, check its documentation for more info: https://caddyserver.com/docs/ |