Impostor/docs/Running-the-server.md

Running the server

There are currently two install methods for Impostor: You can install it normally or inside of a Docker container. If you do not have a particular preference, we recommend the normal installation over the Docker container method.

General remarks for both install methods

This section applies to both the normal installation as well as the Docker (Compose) installation

To connect to the server, you need to configure and install a region file on https://impostor.github.io/Impostor/

Depending on your host you may also need to port forward Impostor to the internet or pass Impostor traffic by your firewall. By default Impostor uses two ports:

• Port 22023 using the UDP protocol
• Port 22000 using the TCP protocol

As port forwarding changes per host or router configuration, port forwarding is not covered by this guide.

Normal installation

1. Install .NET 7.0. We recommend either the ASP.NET Core Runtime or the SDK. The SDK is necessary in case you want to develop Impostor or Impostor plugins.
2. Download the latest release or the latest CI build. Note that Impostor is built for multiple CPU-architectures and operating systems, you most likely want the x64 version, unless you are running on a Raspberry Pi or another device with an ARM processor.
3. Extract the zip.
4. Download the Impostor.Http plugin and put it in your plugins folder.
5. Modify config.json to your liking. Documentation can be found here. You need to at least change PublicIp to the address people will connect to your server to.
6. Run Impostor.Server (Linux/macOS) or Impostor.Server.exe (Windows)
7. (OPTIONAL - Linux) Configure a systemd definition file and enable the service to start on boot - systemd configuration

Using Docker

Docker is a program that allows you to run programs like Impostor in a container.

After installing Docker, you can just start a Docker container with docker run:

docker run -p 22000:22000/tcp -p 22023:22023/udp -e IMPOSTOR_Server__PublicIp=your.public.ip.here aeonlucid/impostor:nightly

Please replace your.public.ip.here with the public IP address of your server. This is the address Among Us will try to reach your client at.

To configure the docker container, either use environment variables or mount config.json in your container.

Using Docker Compose

Docker Compose allows you to start a Docker container using a prefined configuration. This is an example configuration you can continue on:

version: '3.4'

services:
  impostor:
    image: aeonlucid/impostor:nightly
    container_name: impostor
    ports:
      - 22000:22000/tcp
      - 22023:22023/udp
    environment: # Either configure Impostor using environment variables or mount a copy of config.json
      - IMPOSTOR_Server__PublicIp=your.public.ip.here
    volumes:
      - /path/to/local/config.json:/app/config.json # For easy editing of the config
      - /path/to/local/plugins:/app/plugins         # Only needed if using plugins
      - /path/to/local/libraries:/app/libraries     # Only needed if using external libraries