aboutsummaryrefslogtreecommitdiff
path: root/docs/modding-and-development
diff options
context:
space:
mode:
authorBarichello <artur@barichello.me>2022-02-20 07:08:57 -0300
committerGitHub <noreply@github.com>2022-02-20 11:08:57 +0100
commite47a6863dba36d9c4151da25d4fcf07fc46f5daf (patch)
treef6a0c69104f40971b184d5a1140b8857765def10 /docs/modding-and-development
parent3e71452634bf0b0a984926a8b534b3c699dbe68f (diff)
downloadNorthstarWiki-e47a6863dba36d9c4151da25d4fcf07fc46f5daf.tar.gz
NorthstarWiki-e47a6863dba36d9c4151da25d4fcf07fc46f5daf.zip
Master server docs (#42)
* Add intro * Add dev master server docs * Add deploy master server docs * Move files
Diffstat (limited to 'docs/modding-and-development')
-rw-r--r--docs/modding-and-development/development/northstarmasterserver/README.md12
-rw-r--r--docs/modding-and-development/development/northstarmasterserver/deploy.md28
2 files changed, 36 insertions, 4 deletions
diff --git a/docs/modding-and-development/development/northstarmasterserver/README.md b/docs/modding-and-development/development/northstarmasterserver/README.md
index a647fea..664ce18 100644
--- a/docs/modding-and-development/development/northstarmasterserver/README.md
+++ b/docs/modding-and-development/development/northstarmasterserver/README.md
@@ -1,3 +1,11 @@
-# NorthstarMasterServer
+# Hosting a Master Server
-TODO
+## 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](../../installing-northstar/using-northstar/direct-connect.md) or just setup a [normal server](../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/modding-and-development/development/northstarmasterserver/deploy.md b/docs/modding-and-development/development/northstarmasterserver/deploy.md
index c01ea79..e1d5985 100644
--- a/docs/modding-and-development/development/northstarmasterserver/deploy.md
+++ b/docs/modding-and-development/development/northstarmasterserver/deploy.md
@@ -1,3 +1,27 @@
-# Deploy
+# Deploying Master Server
-TODO
+## 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).
+1. Copy the default [dev.env](https://github.com/R2Northstar/NorthstarMasterServer/blob/main/dev.env) to `.env` replace the ip with `127.0.0.1`.
+1. 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/