Host a server

Before you start

You need a machine that stays on. A small VPS or a home PC is enough. A server waiting for players uses very little CPU and about 100 to 250 MB of memory.

You also need the game's maps. The server comes with no game files.

  1. Make a data folder for the server, with a maps folder and a playlists folder in it.
  2. Copy ui.map and all the multiplayer maps into maps. Use the maps from the North American (NTSC) Xbox disc, like the players do.
  3. Copy the playlists folder from the server's download, or write your own.

Halo PC maps go in folders next to maps: maps_ce for Custom Edition, maps_md for HaloMD, maps_pc for Halo PC. The playlists guide has the details.

Pick a way to run it

WayGood for
DockerA Linux server or VPS. It restarts by itself and updates with one command.
LinuxAny Linux machine. One file, nothing to install.
WindowsA Windows PC or Windows server.

Docker

Each release has a ready image, ghcr.io/chupathingyce/server, for x86, x64 and ARM64 Linux. latest is the newest release and nightly is for testing.

  1. Make a folder for the server with your data folder in it (see Before you start).
  2. Download docker-compose.yml into that folder.
  3. Open it and set your server's name, its playlist and how many players it takes.
  4. The server runs as user 1000. If that isn't you, change user: in the file, or run sudo chown -R 1000:1000 data.
  5. Start it:
docker compose up -d
docker compose logs -f

It shows up on this site within a few seconds. To update, run docker compose pull && docker compose up -d.

Many one-click cloud hosts only pass web traffic. Players can't reach a game server there. Use a VPS or your own machine.

More in the Docker guide.

Linux

The server is one file that runs on any Linux. Get it from Downloads or the latest release. Not sure which one? Run uname -m.

  • chupathingyce-server-linux-x64.zip for x86_64: most VPSes and PCs.
  • chupathingyce-server-linux-arm64.zip for aarch64: Oracle Cloud's free tier, Raspberry Pi 4 and 5.
  • chupathingyce-server-linux-x86.zip for i686: older 32-bit PCs. It plays the Xbox maps only; Halo PC and HaloMD maps need x64 or arm64.
  1. Unpack the download.
  2. Go to your data folder.
  3. Start the server with a playlist and a name:
cd /path/to/data
HALO_DEDICATED=playlists/free_for_all.txt HALO_DEDICATED_NAME="My Server" \
  /path/to/chupathingyce-server

Leave it running. Ctrl+C stops it. The log is logs/debug.txt in the data folder.

To keep it running after you log out, use Docker or the systemd service in the Docker and systemd guide.

Windows

Get chupathingyce-server-windows-x64.zip from Downloads. It runs on 64-bit Windows 10 and 11 and Windows Server.

It works like the Linux one. It's a console program with no window of its own.

  1. Unpack the zip into your data folder.
  2. Open start-server.bat in Notepad and set your playlist and your server's name.
  3. Double-click start-server.bat. Leave the window open while the server runs.

Or start it yourself from a command prompt in the data folder:

set HALO_DEDICATED=playlists\free_for_all.txt
set HALO_DEDICATED_NAME=My Server
chupathingyce-server.exe

You can also run it as a Windows service, so it starts with the machine. The README in the zip shows how.

If Windows Firewall asks, allow the server on private and public networks.

Ports

On a home connection you usually don't need to forward any ports. Players reach your server the same way they reach anyone's invite link, even behind a router.

On a cloud server (Oracle, AWS, Google, Azure and the like), incoming UDP is blocked by default. Open one port:

  1. Give the server a fixed port: HALO_NET_TUNNEL_PORT=2302.
  2. Allow incoming UDP 2302 in your provider's firewall.
  3. Allow it on the machine too, for example sudo ufw allow 2302/udp.

Players on your local network also use UDP 5150 and 5160.

The server's control panel is on by default, on the machine itself only (127.0.0.1:8080). In the Docker image it's off until you set HALO_DEDICATED_CONTROL=8080. HALO_DEDICATED_CONTROL=0.0.0.0:8443 opens it to the network, over HTTPS only. You only need that TCP port open if you want to reach the panel from elsewhere. HALO_DEDICATED_CONTROL=off turns it off. The admin guide has the rest.

Moderators

Every server has moderation built in. It works without this site too.

RoleCan
ModeratorSee the players, warn, kick, and ban for up to 7 days.
AdminEverything a moderator can do, plus permanent bans, unbans, and changing the map, playlist and settings.
OwnerEverything an admin can do, plus giving and removing roles, and linking and unlinking. The server's console always has the owner role.

To give someone a role from this site:

  1. Open My servers on your profile, then Manage moderators.
  2. Enter their profile name and pick moderator or admin.
  3. They moderate from the game, from the Moderation screen, once their game is linked to their profile.

Moderators sign in from the game. Their copy of Chupathingy proves who they are, so nobody can pretend to be them. You can moderate anyone in your game, including players on other builds.

Without the site, use sv_mod_add on the console, the moderators.txt file, or the server's own control panel. The moderation guide covers all of them.

Confirming it's you

A ban, unlinking a server, giving someone admin and taking a role away ask you to confirm it's you first. Warning, kicking, changing the map and settings, and giving someone moderator don't.

  • With two-step sign-in on your profile: the code from your authenticator app, or a recovery code.
  • Without it: a code we email to your profile's confirmed address. It works once, for 10 minutes.

Once you've confirmed, you aren't asked again for 30 minutes. Without a confirmed email or two-step sign-in you can add a server and moderate it, but you need one of them to ban or unlink.

Safety

  • Each linked server has its own key, and every request is signed. Copied or forged requests are refused.
  • Every command is checked twice: here against the sender's role, and again on the server against its own role list and its own limit on what this site may do. By default that's nothing beyond admin.
  • The sv_link code proves you run the server. It works once, runs out after 30 minutes, and wrong codes are limited.
  • Every link, role change, command and result is in this site's audit log and in the server's own log.
  • No player's or server's address is shown.
  • Either side can unlink: sv_unlink on the server, or Unlink on its page here. A server can also turn linking off in its settings.

Need help?

The server's README has fixes for the common problems. Or ask us on Discord.