Main Content

Installation Configuration Properties

MATLAB® Online Server™ includes a configuration file that you can use to configure your installation. This file is named install.config and is located in the root of your MATLAB Online Server installation. For example, if you installed the server in your home directory, then it is located at ~/matlab_online_server/install.config.

The tables that follow list the parameters you can modify or enable. If you edit this file while your server is running, you must redeploy the server for your changes to take effect.

Domain Name

Parameter DescriptionDefault

Fully qualified domain name used to access MATLAB Online Server from a web browser. For example: Specifying an IP address as the domain base is not supported.

It is recommended that the domain name is registered to your organization and that the IP address of the server or load balancer are available on the DNS server of the organization.

To test that your domain is working, it is possible to temporarily update the host entry of your client machine to have the IP address and the fully qualified domain name. Then, you can test accessing MATLAB Online Server instance from a browser in your client using this domain name.


If you have a remote registry within your organization, uncomment these parameters and configure the following information about the registry.


Remote Docker® registry to push Docker images to.


Remote Docker repository.

Example: mos


User-friendly name for the Kubernetes® secret object. When you deploy MATLAB Online Server, this object is created from registry credentials. This secret enables the nodes to pull images from the remote registry.

Example: mymossecret



Parameter Description Default

Namespace to use for the deployment.



ParameterDescription Default

MATLAB Online™ sign-in password.

The username for this bootstrapping mode is admin.

For security purposes, it is recommended that you replace the default administration password with a more secure one.

Identity provider configuration for authenticating MATLAB Online users is covered in Configure User Authentication in MATLAB Online Server.


License Server

ParameterDescription Default

MATLAB Online Server license server. Specify the port and hostname IP address in the format port@host.

Example: 14650@


MATLAB license server details. Specify the port and hostname IP address in the format port@host.

Example: 27000@



Consider configuring your environment with Transport Layer Security (TLS). Leverage your organization's best practices for key management, certificate authority, and key rotation for MATLAB Online Server. For a local development environment and during configuration of your environment, it is acceptable to temporarily disable TLS to aid in initial deployment.

IS_TLS_ENABLEDFlag to enable or disable Transport Layer Security (TLS), specified as false or true.false

Path to the TLS key file.

This parameter applies only if IS_TLS_ENABLED is set to true.


Path to the TLS certification file.

This parameter applies only if IS_TLS_ENABLED is set to true.



KUBERNETES_CERTIFICATE_NAME Name of a pre-existing Kubernetes certificate."" (empty string)

Base Container Image

Parameter Description Default
BASE_IMAGE_FLAVORThe base container images that are used to install and configure MATLAB Online Server, specified as debian or rhel.debian

Offline Installation

For details on installing MATLAB Online Server in an offline environment, see Perform Offline MATLAB Online Server Installation.

Parameter Description Default
OFFLINE_MODERun MATLAB Online Server in offline mode, specified as true or false. false

Client-Only Mode

Parameter Description Default
CLIENT_ONLYRun MATLAB Online Server in client-only mode, specified as false or true.false


Parameter Description Default

Log level of MATLAB Online Server, specified as error, warn, info, or debug.

For more verbose logs, specify LOG_LEVEL=debug.

To set the log level for a specific service, in the YAML override file for that service, set the admin > logLevel field. For example:

  logLevel: "debug"

High Availability

Parameter Description Default
IS_HA_ENABLEDOption to enable or disable high availability (HA) for MATLAB Online Server, specified as false or true. For more details, see Enable High Availability in MATLAB Online Server.false

Dashboard Deployment

Parameter Description Default
DEPLOY_DASHBOARDSOption to deploy Grafana dashboards, specified as false or true. These dashboards visualize server metrics gathered by the Prometheus® monitoring system, allowing you to make data-driven decisions to improve server performance. For more details, see Configure Observability in MATLAB Online Server.false


Parameter Description Default

Option to enable or disable a firewall, specified as true or false.

This parameter applies only to single-node installations. For more details, see:

When this firewall is enabled, only ports 22 (SSH), 80 (HTTP) and 443 (HTTPS) are enabled. To communicate on any other port, you must use the ufw (uncomplicated firewall command). For example, this command enables communication on port 8443:

sudo ufw allow 8443


Related Topics