/fivem

FiveM GTA modded multiplayer server

Primary LanguageDockerfile

spritsail/fivem

Latest Version Git Commit Docker Pulls Docker Stars Build Status

This docker image allows you to run a server for FiveM, a modded GTA multiplayer program. Upon first run, the configuration is generated in the host mount for the /config directory. The container should be stopped so fivem can be configured to the user requirements in the server.cfg.

Licence Key

A freely obtained licence key is required to use this server, which should be declared as $LICENCE_KEY. A tutorial on how to obtain a licence key can be found here

Usage

Use the docker-compose script provided if you wish to run a couchdb server with FiveM, else use the line below:

docker run -d \
  --name FiveM \
  --restart=on-failure \
  -e LICENCE_KEY=<your-license-here>
  -p 30120:30120 \
  -p 30120:30120/udp \
  -v /volumes/fivem:/config \
  -ti \
  spritsail/fivem

It is important that you use interactive and pseudo-tty options otherwise the container will crash on startup See issue #3

Environment Varibles

  • LICENSE_KEY - This is a required variable for the licence key needed to start the server.
  • RCON_PASSWORD - A password to use for the RCON functionality of the fxserver. If not specified, a random 16 character password is assigned. This is only used upon creation of the default configs