This project provides a small, alpine based, docker container for the beammp game server and shows its usage in a docker-compose environment.

Because there were no well-documented, alpine based beammp docker images out there, I did one by myself. Building the beammp server is needed, because the prebuilt linux binary uses glibc as C standard library implementation (instead of musl).

The sections below provides use cases for docker and docker-compose.

Quick start:

docker run --name beammp-server \
           -p 30814:30814/tcp -p 30814:30814/udp \
           -e NAME='My first awesome Server' \
           -e AUTH_KEY='<insert auth-key>' \
           rouhim/beammp-server

Check docker-compose.yml if interested. The configuration should be done within the .env file.

To get started copy .env.example to .env.

cp .env.example .env

Adjust the values in the .env to your needs and run:

docker-compose pull && docker-compose up -d

A new AUTH_KEY can be claimed on this site, you will need a Discord account for this. Note that the IP entered there does not matter, despite what the site claims. For more information refer to this wiki page.

In the first place you should consider reading the official mods guide.

The folder mods is created automatically during the first startup, but can also be created manually beforehand.

Just copy the downloaded zip file into the mods folder.

Copy the downloaded zip file into the mods folder.

Now we have to find out the custom map path name (e.g.: /levels/car_jump_arena/info.json), to set it later in the as map to load.

To do so:

1. Execute the shell command below, or open the zip file manually.
2. Copy the absolute path to the info.json location (/levels/{map-name}/info.json).
3. Set in .env file: MAP=/levels/{map-name}/info.json. Example: MAP=/levels/car_jump_arena/info.json

A simple way to print the full map path including info.json (unzip, grep and awk is required):

unzip -l PATH/TO/MAP.zip \
  | grep 'levels/.*/info.json' \
  | awk '{split($0,a," "); print "/"a[4]}'

• BeamMP server repository: https://github.com/BeamMP/BeamMP-Server
• Official server maintenance guide: https://wiki.beammp.com/en/home/server-maintenance
• Official server installation guide: https://wiki.beammp.com/en/home/server-installation
• Inspired by: https://github.com/mastamic-ian/BeamMP_docker
• Built from: https://github.com/RouHim/beammp-docker