spritsail/fivem Docker Image

To run a basic FiveM server, use the spritsail/fivem image. You must provide a valid FiveM license key via the LICENSE_KEY environment variable.

Important: You must use the -ti (interactive and pseudo-tty) flags, otherwise the container will crash on startup.

Upon the first run, the container generates configuration files in the host directory mounted to /config. You should stop the container after the first run to modify the server.cfg to your requirements before starting it again.

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

To use the txAdmin web interface, you must prevent the FXServer binary from using the default execution configuration. This is done by setting the NO_DEFAULT_CONFIG environment variable to any non-zero value.

txAdmin stores its configuration and database in /txData. To ensure this data persists across container restarts, you must mount a volume to /txData. You also need to expose the txAdmin webserver port (default 40120).

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

Use the following docker-compose.yml structure to deploy the FiveM server. You must provide a valid LICENSE_KEY in the environment section and configure volume mounts for your server resources and txAdmin data to ensure persistence.

version: '3'

services:
  fivem:
    image: spritsail/fivem
    container_name: fivem
    restart: always
    stdin_open: true
    tty: true
    volumes:
      - "/path/to/resources/folder:/config"
      # - "/path/to/txData/folder:/txData"
    ports:
      - "30120:30120"
      - "30120:30120/udp"
      # - "40120:40120"
    environment:
      LICENSE_KEY: "license-key-here"

The spritsail/fivem image provides two main tags:

• latest: The default tag, based on the most recent FiveM build.
• stable: Based on the "optional" FiveM release.

Note: An image based on the "recommended" FiveM release is not provided as it is typically too stale.

The following environment variables are used to configure the FiveM container:

The following environment variable is required for the container to function:

• LICENSE_KEY: Your FiveM server license key.

environment:
  LICENSE_KEY: "license-key-here"

Use volumes to persist server data and configuration outside the container lifecycle:

• /config: Mount your server resources and configuration files here (e.g., - "/path/to/resources/folder:/config").
• /txData: Mount txAdmin's data files here to persist txAdmin settings and data (e.g., - "/path/to/txData/folder:/txData").

volumes:
  - "/path/to/resources/folder:/config"
  - "/path/to/txData/folder:/txData"

Expose the following ports to allow client connections and web management:

• 30120 (TCP): The default FiveM server port.
• 30120 (UDP): The default FiveM server port for UDP traffic.
• 40120 (TCP): The default port for the txAdmin web interface.

ports:
  - "30120:30120"
  - "30120:30120/udp"
  - "40120:40120"