]> git.deb.at Git - rhonda/impostor.git/commitdiff
Improve setup documentation (#485)
authorminiduikboot <mini@duikbo.at>
Mon, 29 Aug 2022 18:56:34 +0000 (20:56 +0200)
committerGitHub <noreply@github.com>
Mon, 29 Aug 2022 18:56:34 +0000 (20:56 +0200)
- .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

index 4ab0551b16cd74ca026d89e1753d1131da0189b2..f985fe02a84123dbcda302f57f564bf5170245ff 100644 (file)
@@ -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)