From a0b5228e711c275dfba65be876e4af77e29f6883 Mon Sep 17 00:00:00 2001 From: miniduikboot Date: Mon, 29 Aug 2022 20:56:34 +0200 Subject: [PATCH] Improve setup documentation (#485) - .NET download link was broken - They also renamed their packages slightly, so update wording - Add a note on port forwarding - Add a note on setting up the region file --- docs/Running-the-server.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/Running-the-server.md b/docs/Running-the-server.md index 4ab0551..f985fe0 100644 --- a/docs/Running-the-server.md +++ b/docs/Running-the-server.md @@ -6,13 +6,17 @@ There are currently two modes to run the Impostor server. The first way, Single ### Without Docker -1. Install the [.NET 6.0 runtime](https://dotnet.microsoft.com/download/6.0). Installing the SDK also works, but is not necessary unless you plan on developing Impostor or Impostor plugins. If you're asked to pick between a console, desktop or server runtime, the console runtime is enough. +1. Install the [.NET 6.0 runtime](https://dotnet.microsoft.com/download/dotnet/6.0). Installing the SDK also works, but is not necessary unless you plan on developing Impostor or Impostor plugins. If you're asked to pick between the normal, desktop or server runtime, the normal runtime is enough, but some plugins may require the ASP.NET Core Runtime as well. 2. Find the [latest release](https://github.com/Impostor/Impostor/releases) or the [latest CI build](https://ci.appveyor.com/project/Impostor/Impostor/branch/master/artifacts). 3. Download the version for your OS (linux/win/osx). Impostor is built for multiple CPU-architectures, you most likely want the x64 version, unless you are running on a Raspberry Pi or another device with an ARM processor. 4. Extract the zip. 5. Modify `config.json` to your liking. Documentation can be found [here](Server-configuration.md) _(this step is mandatory if you want to expose this server to other devices)_ 6. Run `Impostor.Server` (Linux/macOS) or `Impostor.Server.exe` (Windows) +Depending on your host you may also need to port forward Impostor to the internet. By default Impostor uses port **22023** and the **UDP** protocol. As port forwarding changes per host or router configuration, port forwarding is not covered by this guide. + +To connect to the server, you need to configure a region file on https://impostor.github.io/Impostor/ + ### Using Docker [![Docker Image](https://img.shields.io/docker/v/aeonlucid/impostor?sort=semver)](https://hub.docker.com/r/aeonlucid/impostor) -- 2.39.5