Set Up and Log In to MATLAB Production Server Dashboard

Follow these instructions to set up, start, and log in the dashboard for an on-premises installation of MATLAB^® Production Server™. You can use the dashboard to create and manage server instances.

Set Up Dashboard

Warning

You must have administrator privileges on Windows^® to complete the setup.

Open a Terminal or Command Window with administrator privileges, and navigate to the dashboard directory in the MATLAB Production Server installation directory.

Platform	Default Directory Where MATLAB Production Server Dashboard Is Installed
Windows (Administrator)	C:\Program Files\MATLAB\MATLAB Production Server\R2024b\dashboard
Linux^®	/usr/local/MATLAB/MATLAB_Production_Server/R2024b/dashboard

Execute the mps-dashboard script with the setup option, and when prompted, specify the directory for dashboard setup.

You must have write privileges to the directory where MATLAB Production Server is installed and to the workspace directory where the dashboard is going to be set up.

Platform

Platform	Script for Dashboard Setup
Windows (Administrator)	`> mps-dashboard.bat setup` For example: > mps-dashboard.bat setup Specify a workspace directory for MATLAB Production Server Dashboard: C:\mps\dashboard
Linux	`$ ./mps-dashboard.sh setup` For example: $ ./mps-dashboard.sh setup Specify a workspace directory for MATLAB Production Server Dashboard: /opt/mps/dashboard

Script for Dashboard Setup

Windows (Administrator)

> mps-dashboard.bat setup

For example:

> mps-dashboard.bat setup
Specify a workspace directory for MATLAB Production Server Dashboard: C:\mps\dashboard

Linux

$ ./mps-dashboard.sh setup

For example:

$ ./mps-dashboard.sh setup
Specify a workspace directory for MATLAB Production Server Dashboard: /opt/mps/dashboard

You receive a message acknowledging that the dashboard has been successfully setup.

Tip

To directly specify a directory when setting up the dashboard, use the -C option after the setup option and provide a directory name.

For example, at the Windows command prompt, type: mps-dashboard.bat setup -C D:\mps\dashboard

For example, in the Linux terminal, enter: ./mps-dashboard.sh setup -C /opt/mps/dashboard

Note

To view the list of options that the mps-dashboard script accepts, pass a ? as an option to the mps-dashboard script.

For example, at the Windows command prompt, type:

mps-dashboard.bat ?

For example, in the Linux terminal, type:

./mps-dashboard.sh ?

The complete list of options are as follows:

setup | start | stop | remove | reset_admin_password

Tip

If you see garbled text in the dashboard logs, verify that the server machine uses UTF-8 encoding. You must execute mps-dashboard.bat setup again after setting the locale.

For information about setting the locale, see Set Locale and Display Language (MATLAB).

Start Dashboard

Open a Terminal or Command Window with a user account that does not have administrator privileges, then navigate to the dashboard directory in the MATLAB Production Server installation directory.

To start the dashboard, it is recommended that you run the mps-dashboard script with a least privilege user account that has write privileges to the MATLAB Production Server Dashboard workspace directory.

Platform	Default Directory Where MATLAB Production Server Dashboard Is Installed
Windows	`C:\Program Files\MATLAB\MATLAB Production Server\R2024b\dashboard`
Linux	`/usr/local/MATLAB/MATLAB_Production_Server/R2024b/dashboard`

Execute the mps-dashboard script with the start option to start the dashboard.

Platform	Script to Start Dashboard
Windows	`mps-dashboard.bat start`
Linux	`./mps-dashboard.sh start`

After the dashboard starts, you see a message at the terminal indicating the host and port where the dashboard is running. The default host and port are localhost and 9090, respectively.

Tip

Windows only: To run the dashboard instance as a background process in Windows, precede the mps-dashboard script with command start /B.

For example: start /B mps-dashboard.bat start

Note

You can change the default port used by dashboard by editing the --node_server_port option in config.txt file. You can find the config.txt file here:

Platform	Location of `config.txt` File
Windows	`C:\Program Files\MATLAB\MATLAB Production Server\R2024b\dashboard\config\config.txt`
Linux	`/usr/local/MATLAB/MATLAB_Production_Server/R2024b/dashboard/config/config.txt`

To make other customizations to the setup process, you can edit the relevant parts of the config.txt file.

Open a web browser, and type the host and port number that were displayed in the previous step.
For example:
```
http://localhost:9090
```

Log In to Dashboard

To log in to MATLAB Production Server Dashboard follow this procedure:

Open a web browser, and type the host and port number that were displayed at the end of the install process.
For example:
```
http://localhost:9090
```
Type the following information at the login screen for the username and password:
Username: admin
Password: admin

You are now logged into the MATLAB Production Server Dashboard.

Reset Administrator Password

You can use the mps-dashboard script with the option reset_admin_password to change the administrator password.

Platform	Script to Reset Administrator Password
Windows	`mps-dashboard.bat reset_admin_password`
Linux	`./mps-dashboard.sh reset_admin_password`

Warning

Do not execute the reset_admin_password option while the dashboard is still running. First, stop dashboard execution using the mps-dashboard script with the stop option, then reset the administrator password.