aboutsummaryrefslogtreecommitdiff
path: root/docs/hosting-a-server-with-northstar/dedicated-server.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/hosting-a-server-with-northstar/dedicated-server.md')
-rw-r--r--docs/hosting-a-server-with-northstar/dedicated-server.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/hosting-a-server-with-northstar/dedicated-server.md b/docs/hosting-a-server-with-northstar/dedicated-server.md
new file mode 100644
index 0000000..2c00297
--- /dev/null
+++ b/docs/hosting-a-server-with-northstar/dedicated-server.md
@@ -0,0 +1,18 @@
+# Hosting a Dedicated Server
+
+## Setup
+
+Dedicated servers allow you to host a Northstar server without having to use a full client, making them more lightweight and easier to host for longer periods of time. Dedicated servers are still in development for Northstar, so while they do work, expect some bugs and general jank.\
+To start a dedicated server on Northstar, launch NorthstarLauncher.exe with the argument `-dedicated`, this can be done manually, but releases also provide the batch file `r2ds.bat`, which will also do this.\
+When using a dedicated server, arguments are read from `ns_startup_args_dedi.txt`, rather than `ns_startup_args.txt`.
+
+## Dedicated Server Caveats
+At the moment, dedicated servers still require DirectX 11 to work, which typically requires a physical GPU, though they use almost no GPU processing power while in use, this can be an issue especially on GPU-less setups, so the launch argument `-softwared3d11` can be used to force DirectX to run in software mode.\
+While this is absolutely not ideal, it's the best solution for truely headless dedicated servers at the moment, and surprisingly hardly uses any CPU time, though it can use roughly up to 1GB of RAM.\
+Regarding RAM usage, dedicated servers also use significant amounts of RAM at the moment, often requiring 1.5-2GB, though I expect this to lower as development continues.
+
+## Hosting on Linux
+
+> **TODO:** If you got experience with hosting a dedicated server on Linux as well as setting up a dedicated server in container environments please extend this section.
+
+[This issue thread on Github](https://github.com/R2Northstar/Northstar/issues/49) contains some instructions to succesfully host a dedicated server on Linux.