Documentation

Contents

• Preliminaries
• Key Concepts
• Obtaining Container Images
• Use Cases
• Environment Setup

Preliminaries

Tips for getting started and information about the Unreal Containers community hub itself.

• Quickstart Guide

  Quickly find the information you need to start using Unreal Engine containers in your own workflows.

• Technology Selection Guide

  When should I use Linux containers or Windows containers? When should I not use containers at all?

• Unreal Containers Community Hub

  What is the Unreal Containers community hub and who maintains it?

• Professional Support

  Where can I get professional support to assist in using Unreal Engine containers?

Key Concepts

Understand key concepts that provide context for Unreal Engine containers and help you to unlock their full potential.

• Development images vs. runtime images

  What are the two types of Unreal Engine container images and how do they differ?

• Windows Containers

  How are Windows containers different to Linux containers and how can they be used most effectively?

• macOS Containers

  Linux and Windows containers exist, but what about macOS?

• GPU acceleration in containers

  How can GPU acceleration be used to perform rendering or computational tasks inside Linux and Windows containers?

• NVIDIA Container Toolkit

  What is the NVIDIA Container Toolkit and how can it be used to run Linux containers with full GPU acceleration?

• Audio output in containers

  How can audio output be enabled in Unreal Engine containers and when is it necessary?

Obtaining Container Images

Obtain Unreal Engine container images via methods that are compliant with the Unreal Engine EULA.

• Unreal Engine EULA Restrictions

  Understand how the Unreal Engine EULA restricts the distribution of Unreal Engine container images.

• Available Image Sources

  What EULA-compliant sources are available for obtaining Unreal Engine container images?

• Official Container Images

  Use the official Unreal Engine container images provided by Epic Games.

• ue4-docker

  Build Unreal Engine development container images using the ue4-docker project.

• Writing Dockerfiles

  Write your own Dockerfiles to build Unreal Engine development container images.

Use Cases

Explore the workflows and use cases that are enabled and enhanced by Unreal Engine containers.

• Continuous Integration and Deployment (CI/CD)

  Use reproducible environments to build and deploy Unreal Engine projects and plugins.

• Pixel Streaming

  Render video and stream it to web browsers in real-time over WebRTC for interactive use.

• Microservices

  Build and deploy cloud native microservices powered by Unreal Engine technology.

• AI and Machine Learning

  Run Unreal Engine simulations alongside machine learning workloads in the cloud.

• Rendering Linear Media

  Perform batch rendering of images or video for non-interactive use.

• Dedicated Servers

  Run Unreal Engine dedicated servers for multiplayer experiences.

• Linux Installed Builds

  Use container images as a source of pre-built binaries in lieu of the Epic Games Launcher under Linux.

• Linux Sandboxed Editor

  Run the Unreal Editor inside a container and interact with it directly from the host system.

• Multi-Display Output

  Display rendered output from Unreal Engine projects on multiple displays.

• Cloud Rendering (Deprecated)

  Note: this overview page has been deprecated and is being split into other, more specific use cases.

Environment Setup

Configure development or production environments for building and running Unreal Engine containers.

• Amazon Web Services (AWS)

  Configure a development or production environment running on AWS.

• Google Cloud Platform (GCP)

  Configure a development or production environment running on GCP.

• Microsoft Azure

  Configure a development or production environment running on Azure.

• Local Development (Linux)

  Configure a local Linux development environment.

• Local Development (Windows Server)

  Configure a local Windows Server development environment.

• Local Development (Windows 10)

  Configure a local Windows 10 development environment.

• Local Development (macOS)

  Configure a local macOS development environment.