timoschwarzer/supertuxkart-server repository overview

⁠Docker SuperTuxKart Server

This is a docker image for deploying a SuperTuxKart⁠ server.

⁠What is SuperTuxKart?

SuperTuxKart (STK) is a free and open-source kart racing game, distributed under the terms of the GNU General Public License, version 3. It features mascots of various open-source projects. SuperTuxKart is cross-platform, running on Linux, macOS, Windows, and Android systems. Version 1.0 was officially released on April 20, 2019.

SuperTuxKart started as a fork of TuxKart, originally developed by Steve and Oliver Baker in 2000. When TuxKart's development ended around March 2004, a fork as SuperTuxKart was conducted by other developers in 2006. SuperTuxKart is under active development by the game's community.

⁠How to use this image

The image exposes ports 2759 (server) and 2757 (server discovery). The server should be configured using your own server config file. The config file template can be found here⁠. Mount it at /stk/server_config.xml:

$ docker run --name my-stk-server \
             -d \
             -p 2757:2757 \
             -p 2759:2759 \
             -v $(pwd)/config.xml:/app/config.xml \
             # -e INSTALL_ADDONS=1 # Install all addons after starting
             timoschwarzer/supertuxkart-server:1.2-4

For hosting a public internet server (by setting wan-server to true in the config file) it is required to log in with your STK account. You can register a free account here⁠. Pass your username and password to the container via environment variables.

$ docker run --name my-stk-server \
             -d \
             -p 2757:2757 \
             -p 2759:2759 \
             -v $(pwd)/config.xml:/app/config.xml \
             -e USERNAME=myusername \
             -e PASSWORD=mypassword \
             timoschwarzer/supertuxkart-server:1.2-4