Create MATLAB Container Image

This repository shows you how to build and customize a Docker® container for MATLAB® and its toolboxes, using the MATLAB Package Manager (mpm). You can use this container image as a scalable and reproducible method to deploy and test your MATLAB code.

Use the Dockerfile in this top-level repository if you want a lightweight and simple way to create a MATLAB container image. You can also download prebuilt images based on the Dockerfile from here.

For alternative resources, see the alternates folder that contains the following Dockerfiles:

• The Dockerfile in matlab-installer uses the MATLAB installer rather than mpm to install MATLAB in the container. This allows you to install toolboxes that are not currently supported by mpm. Use this Dockerfile if you prefer using the MATLAB installer workflow, instead of mpm.
• The Dockerfile in building-on-matlab-docker-image shows you how to build on top of the MATLAB Container Image on Docker Hub. Use this Dockerfile if you want to install extra toolboxes on top of the mathworks/matlab container image. This Dockerfile contains the features of the MATLAB image on Docker Hub, allowing you to access the dockerised MATLAB through a browser, batch mode, or an interactive command prompt.
• The Dockerfile in non-interactive allows you run MATLAB in non-interactive environments. This Dockerfile requires that you have a MATLAB batch licensing token to license MATLAB in the container. Use this Dockerfile in continuous integration and continuous delivery (CI/CD) pipelines or other automated environments where interactive licensing is not possible.
• The Dockerfile in matlab-container-offline-install shows you how to build and customize a Docker container for MATLAB and its toolboxes in an offline environment. Use this Dockerfile if you must build your container image in an offline environment.

For more Docker related resources, see More MATLAB Docker Resources.

Requirements

• A running network license manager for MATLAB — For more information, see Using the Network License Manager.
• Docker.

Build Instructions

Get Sources

Access the Dockerfile either by directly downloading this repository from GitHub®, or by cloning this repository and then navigating to the appropriate folder.

git clone https://github.com/mathworks-ref-arch/matlab-dockerfile.git
cd matlab-dockerfile

Build and Run Docker Image

Build container with a name and tag of your choice.

docker build -t matlab:R2024b .

Run the container. Test the container by running an example MATLAB command, such as ver.

docker run --init --rm -e MLM_LICENSE_FILE=27000@MyServerName matlab:R2024b -batch ver

The Dockerfile defaults to building a container for MATLAB R2024b.

The example command ver displays the version number of MATLAB and other installed products. For more information, see ver. For more information on running the container, see the Run the Container section.

Note

Use the --init flag in the docker run command to ensure that the container stops gracefully when a docker stop or docker kill command is issued. For more information, see these links:

• Reference page for docker run
• Blog post on the usage of init

Customize the Image

By default, the Dockerfile installs the latest available MATLAB release without any additional toolboxes or products in the /opt/matlab/${MATLAB_RELEASE} folder.

Use the options below to customize your build.

Customize MATLAB Release, MATLAB Product List, MATLAB Install Location, and License Server

The Dockerfile supports these Docker build-time variables:

Argument Name	Default value	Description
MATLAB_RELEASE	R2024b	MATLAB release to install, for example, R2023b.
MATLAB_PRODUCT_LIST	MATLAB	Space-separated list of products to install, for example, MATLAB Simulink Deep_Learning_Toolbox Fixed-Point_Designer. For more information, see MPM.md.
MATLAB_INSTALL_LOCATION	/opt/matlab/R2024b	Path to install MATLAB.
LICENSE_SERVER	unset	Port and hostname of the machine that is running the network license manager, using the port@hostname syntax. For example: 27000@MyServerName

Use these arguments with the the docker build command to customize your image. Alternatively, you can change the default values for these arguments directly in the Dockerfile.

Build an Image for a Different MATLAB Release

For example, to build an image for MATLAB R2019b, use this command.

docker build --build-arg MATLAB_RELEASE=R2019b -t matlab:R2019b .

Build an Image with a Specific Set of Products

For example, to build an image with MATLAB and Simulink®, use this command.

docker build --build-arg MATLAB_PRODUCT_LIST='MATLAB Simulink' -t matlab:R2024b .

Build an Image with MATLAB Installed to a Specific Location

For example, to build an image with MATLAB installed at /opt/matlab, use this command.

docker build --build-arg MATLAB_INSTALL_LOCATION='/opt/matlab' -t matlab:R2024b .

Build an Image Configured to Use a License Server

Including the license server information with the docker build command means you do not have to pass it when running the container.

# Build container with the license server.
docker build --build-arg LICENSE_SERVER=27000@MyServerName -t matlab:R2024b .

# Run the container without needing to pass license information.
docker run --init --rm matlab:R2024b -batch ver

Use the Network License Manager

This container requires a network license manager to license and run MATLAB. You need either the port and hostname of the network license manager or a network.lic file.

Step 1: Contact your system administrator, who can provide one of the following:

• The address to your server, and the port it is running on, for example, [email protected]

• A network.lic file containing these lines.

  # Sample network.lic
  SERVER MyServerName.example.com <optional-mac-address> 27000
  USE_SERVER

• A license.dat file. Open the license.dat file, find the SERVER line, and either extract the port@hostname, or create a network.lic file by copying the SERVER line and adding a USE_SERVER line below it.

  # Snippet from sample license.dat
  SERVER MyServerName.example.com <mac-address> 27000

---

Step 2: Use port@hostname or the network.lic file with either the docker build or the docker run command.

With the docker build command, either:

• Specify the LICENSE_SERVER build-arg.

  # Example
  docker build -t matlab:R2024b --build-arg LICENSE_SERVER=27000@MyServerName .

• Use the network.lic file.

  1. Place the network.lic file in the same folder as the Dockerfile.
  2. Uncomment the line COPY network.lic /opt/matlab/licenses/ in the Dockerfile.
  3. Run the docker build command without the LICENSE_SERVER build-arg:

  # Example
  docker build -t matlab:R2024b .

With the docker run command, use the MLM_LICENSE_FILE environment variable.

docker run --init --rm -e MLM_LICENSE_FILE=27000@MyServerName matlab:R2024b -batch ver

Run the Container

If you did not provide the license server information when building the image, then provide it when running the container. Set the environment variable MLM_LICENSE_FILE using the -e flag, with the network license manager's location in the format port@hostname.

# Start MATLAB, print version information, and exit.
docker run --init --rm -e MLM_LICENSE_FILE=27000@MyServerName matlab:R2024b -batch ver

You can run the container without specifying MLM_LICENSE_FILE if you provided the license server information when building the image, as shown in the examples below.

Run MATLAB in an Interactive Command Prompt

To start the container and run MATLAB in an interactive command prompt, use this command.

docker run --init -it --rm matlab:R2024b

Run MATLAB in Batch Mode

To start the container, run a MATLAB command, and then exit, use this command.

# Container runs the command RAND in MATLAB and exits.
docker run --init --rm matlab:R2024b -batch rand

Run MATLAB with Startup Options

To override the default behavior of the container and run MATLAB with any set of arguments, such as -logfile, use this command.

docker run --init -it --rm matlab:R2024b -logfile "logfilename.log"

To learn more, see the documentation: Commonly Used Startup Options.

More MATLAB Docker Resources

• Explore prebuilt MATLAB Docker Containers on Docker Hub: https://hub.docker.com/r/mathworks.

  • MATLAB Containers on Docker Hub hosts container images for multiple releases of MATLAB.
  • MATLAB Deep Learning Containers on Docker Hub hosts container images with toolboxes suitable for Deep Learning.

• Enable additional capabilities using the MATLAB Dependencies repository. For some workflows and toolboxes, you must specify dependencies. You must do this if you want to do these tasks:

  • Install extended localization support for MATLAB
  • Play media files from MATLAB
  • Generate code from Simulink
  • Use mex functions with gcc, g++, or gfortran
  • Use the MATLAB Engine API for C and Fortran®
  • Use the Polyspace® 32-bit tcc compiler

  The MATLAB Dependencies repository lists Dockerfiles for various releases and platforms. To view the Dockerfile for R2024b, click here.

  These Dockerfiles contain commented lines with the libraries that support additional capabilities. Copy and uncomment these lines into your Dockerfile.

Help Make MATLAB Even Better

You can help improve MATLAB by providing user experience information on how you use MathWorks products. Your participation ensures that you are represented and helps us design better products. To opt out of this service, delete this line in the Dockerfile.

ENV MW_DDUX_FORCE_ENABLE=true MW_CONTEXT_TAGS=MATLAB:DOCKERFILE:V1

To learn more, see the documentation: Help Make MATLAB Even Better - Frequently Asked Questions.

Feedback

We encourage you to try this repository with your environment and provide feedback. If you encounter a technical issue or have an enhancement request, create an issue here.

---

Copyright 2021-2024 The MathWorks, Inc.

---