Unreal Tournament 2004 Server

UT2004 Server, packaged nicely in a container

Some Notes

This image contains no server data. Instead, it downloads all the data it needs:

UT2004 Server v3369_2 (latest version)
ECE Bonus Pack (extra maps)
Official Megapack (extra maps)
CSS fixes and UWeb UTF-8 fixes

It downloads them on first launch, keeping the image size down and allowing for it to be updated without redownloading all of the unchanging UT2004 server files. If there is an update to the contents of the server, there is an updater system in place. Additionally, this updater will not overwrite any .ini files, as they are stored elsewhere. I also can't imagine there will ever be an update, but hey it's there just in case.

How To Run

This is the base command:

docker run -v /path/to/data:/data -p 7777:7777/udp -e CD_KEY=YOUR-CDKEY-HERE -e PUID=1000 phasecorex/ut2004-server

-v /path/to/data:/data: The path to a data directory. The entire server and all data will be downloaded here. This NEEDS to have a volume mounted to it for the container to start.
-p 7777:7777/udp: Port for the game server to listen on. You need this for game clients to connect to the server.
-e CD_KEY=YOUR-CDKEY-HERE: Your server CD key. This is needed for first run; afterwards you will see a cdkey file created in the /data/config folder and can safely omit this environment variable.
-e PUID=1000: The user ID you want this server to run as.
-e PGID=1000: You can also specify a group ID. If not specified, it defaults to whatever PUID is set to.
-e TZ=America/Detroit: You can specify the timezone that you want the server to run in. Useful for logging.
-e DOWNLOAD_DATA=true: In order to actually initiate the downloads, this must be set to true. Setting this to true means that you understand that ~750MB of data will be downloaded and extracted (~2.8GB) to the mounted /data directory.

Folder Layout

The /data folder will have three main folders:

server: The base server files that were downloaded. If you can help it, don't modify anything in here.
addons: Same layout as the server folder. You can add all of your custom maps and mutators here.
config: All .ini files from the server and addon folders, as well as the cdkey file, will automatically be moved here for easy managing.

CD Key

This server needs a cdkey file to work correctly, the contents of which being a UT2004 server key. You can either specify the environment variable CD_KEY=YOUR-CDKEY-HERE, or you can place an already created cdkey file into the /data/config folder. Once the cdkey file has been created (either method), you do not need to specify the environment variable anymore.

Addons

Simply extract your custom maps and mutators to the /data/addons folder (it has the same layout as the server folder structure) and then restart your server. All of your addons will then be present in the server. This keeps your addons and the core server maps nice and separate.

Ports

Here are the ports you can expose on the Docker image:

7777:7777/udp (Game Port)
7778:7778/udp (Query Port; game port + 1)
7787:7787/udp (GameSpy Query Port; game port + 10)
80:8080 (Port set via ListenPort that your WebAdmin will run on)

The right number is the port (and protocol) defined in your UT2004.ini file, and the left is what it is exposed as outside of Docker. You will want to have the /udp part included on those first three ports, otherwise no clients will be able to connect to your server! At minimum you will need the game port defined, and if you want other clients to query information from your server, you'd want both query ports defined. I don't recommend exposing the WebAdmin port to the outside world.

Other Environment Variables

COMPRESS_DIR (default is empty) - If you want to compress all of your server files to set up a redirect download server, set this environment variable to a directory (such as /compressed). Then, have a volume mount to that directory to access the compressed files. Any file not found in that folder will be compressed there.
SERVER_START_EXTRAS (default is empty) - If you need to add any other parameters to the server launch command, put them in this variable. For example to use UT2Vote, you need to set this to ?Mutator=UT2Vote61.UT2VoteX
SERVER_START_COMMAND (default is DM-Antalus?game=xGame.xDeathMatch) - If you need to change the actual server start command (for instance, to change the first gametype and map), set this variable.
SKIP_INSTALL (default is empty) - If you don't want to download/update your server files, set this to true. I assume you know what you're doing. Maybe manually installing your own server to the /data/server folder or something? I don't know.

A Note On Downloading the Server

All of the official server downloads hosted in variaous locations all had issues, such as incorrect filename casing (leading to duplicated non-patched files on Linux), the UWeb and CSS problems, or some archives extracting incorrectly. I have taken the time to compile the server, both bonus packs, and the latest patches (which patch the bonus packs, hence why they were included) and made a nice compressed archive. However, I can't host a ~750MB file myself, due to residential bandwith caps and upload speeds. If for some reason my chosen host does not work (link is too popular), let me know and I will update the installer.

A Note On Unraid (or Other FUSE Filesystems)

UT2004 Server does NOT work with FUSE filesystems. This is the filesystem that Unraid uses for it's /mnt/user/ folder in order to merge all of your disks into one large folder. Not sure why it doesn't work, I just know it doesn't. For best results, just point the /data volume somewhere in /mnt/cache/appdata or /mnt/diskX/appdata, since those are pointed directly at a disk instead of a FUSE filesystem.

MorgothRB / docker-ut2004-server