Impostor/docs/Http-server.md

HTTP Server

Since Impostor 1.9.0 a HTTP service is included for matchmaking, which is required for clients to connect to the Impostor server.

Starting from Among Us 16.0.5, you need to set up HTTPS for players to connect to your server. Unfortunately Impostor doesn't handle SSL certificates, so you need to set up a reverse proxy.

Use a reverse proxy

A reverse proxy allows you to forward HTTP requests from users to multiple services. If you already have one, you should configure it to add Impostor.

If you have never set up a reverse proxy before, we recommend you to set up Caddy. It is easy to set up and comes with support for requesting SSL certificates out of the box.

To prevent people from connecting directly to Impostor, we recommend changing the "ListenIp" in the "HttpServer" section to "127.0.0.1". This makes sure people can't connect to your HTTP server other than via your reverse proxy. Keep the "ListenIp" in the "Server" section at "0.0.0.0" though, running the normal game traffic through a proxy is not supported.

Caddy

To install Caddy, follow the official installation guide. Then use the following lines as your Caddyfile configuration file:

example.com # replace example.com with your domain name

reverse_proxy :22023

Now run caddy run in the folder with this Caddyfile and it should set up a server for you with a free SSL certificate. If this works, you should set up Caddy to run in the background

Nginx

Nginx is an alternative to Caddy that is a bit harder to set up. If you already use Nginx, you can use our snippet to add Impostor:

Nginx configuration

server {
    listen 443 ssl http2;
    server_name example.com; # replace example.com with your domain name

    # Assuming you're using Certbot, replace example.com with your domain name
    ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem;
    ssl_trusted_certificate /etc/letsencrypt/live/example.com/fullchain.pem;

    location / {
        proxy_pass http://localhost:22023; # Change the port to your HttpServer's ListenPort
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

# Redirect all traffic to HTTPS
server {
    listen 80 default_server;
    location / {
        return 307 https://$host$request_uri;
    }
}

Stop exposing Impostor's HTTP server to the internet directly

To only allow connections to Impostor's HTTP servers via the reverse proxy, we recommend to set the ListenIp of the HTTP server to 127.0.0.1:

{
 // NOTE: merge this snippet into the rest of your configuration
 "HttpServer": {
   "ListenIp": "127.0.0.1"
 }
}

Or if you're configuring Impostor with environment variables:

IMPOSTOR_HttpServer__ListenIp=127.0.0.1

For more information on server configuration, see [Server-configuration.md](Server Configuration).