ue4-docker

Building Images

List of available container images

You can build the following images using the ue4-docker build command:

By default, all available images will be built. You can prevent unwanted images from being built by appending the relevant image-specific flag to the build command (see the “Flag to disable” entry for each image below.)

ue4-build-prerequisites

Tags:

  • Windows containers: adamrehn/ue4-build-prerequisites:BASETAG where BASETAG is the Windows Server Core base image tag

  • Linux containers: adamrehn/ue4-build-prerequisites:CONFIGURATION where CONFIGURATION is as follows:

    • opengl if CUDA support is not enabled

    • cudaglVERSION where VERSION is the CUDA version if CUDA support is enabled (e.g. cudagl9.2, cudagl10.0, etc.)

Dockerfiles: Windows | Linux

Flag to disable: ue4-docker will always build this image if it does not already exist.

Contents: Contains the build prerequisites common to all Engine versions.

Uses:

  • Keep this image on disk to speed up subsequent container image builds.

ue4-source

Tags:

  • adamrehn/ue4-source:RELEASE where RELEASE is the Engine release number

  • adamrehn/ue4-source:RELEASE-PREREQS where RELEASE is as above and PREREQS is the ue4-build-prerequisites image tag

Dockerfiles: Windows | Linux

Flag to disable: ue4-docker will always build this image if it does not already exist.

Contents: Contains the cloned source code for UE4, along with its downloaded dependency data. The ue4-engine and ue4-minimal images use this source code as the starting point for their builds.

Uses:

  • Only needed during the build process. Afterwards, this image can be removed using ue4-docker clean --source to save disk space.

ue4-engine

Tags:

  • adamrehn/ue4-engine:RELEASE where RELEASE is the Engine release number

  • adamrehn/ue4-engine:RELEASE-PREREQS where RELEASE is as above and PREREQS is the ue4-build-prerequisites image tag

Dockerfiles: Windows | Linux

Flag to disable: --no-engine

Contents: Contains a source build of the Engine.

Uses:

ue4-minimal

Tags:

  • adamrehn/ue4-minimal:RELEASE where RELEASE is the Engine release number

  • adamrehn/ue4-minimal:RELEASE-PREREQS where RELEASE is as above and PREREQS is the ue4-build-prerequisites image tag

Dockerfiles: Windows | Linux

Flag to disable: --no-minimal

Contents: Contains the absolute minimum set of components required for use in a Continuous Integration (CI) pipeline, consisting of only the build prerequisites and an Installed Build of the Engine.

Uses:

  • Use this image for CI pipelines that do not require ue4cli, conan-ue4cli, or ue4-ci-helpers.

ue4-full

Tags:

  • adamrehn/ue4-full:RELEASE where RELEASE is the Engine release number

  • adamrehn/ue4-full:RELEASE-PREREQS where RELEASE is as above and PREREQS is the ue4-build-prerequisites image tag

Dockerfiles: Windows | Linux

Flag to disable: --no-full (will be disabled automatically if ue4-minimal is not being built)

Contents: Contains everything from the ue4-minimal image, and adds the following:

  • ue4cli
  • conan-ue4cli
  • ue4-ci-helpers
  • UE4Capture (Linux image only)
  • PulseAudio support (Linux image only)
  • X11 support (Linux image only)

Uses:

  • CI pipelines that require ue4cli, conan-ue4cli, or ue4-ci-helpers
  • Packaging or running cloud rendering projects that optionally utilise UE4Capture under Linux (note that the ue4-runtime image is the recommended base image for running cloud rendering workloads, since this avoids including the multi-gigabyte UE4 developer tools)
  • Packaging UE4-powered microservices