Follow these instructions to set up the dashboard for an on-premises installation of MATLAB® Production Server™.
You must have admin privileges on Windows® to complete setup.
To set up an instance of the MATLAB Production Server dashboard:
Open a Terminal or Command Window with administrator privileges, and
navigate to the
dashboard folder in the MATLAB
Production Server installation directory.
Default Directory Where the MATLAB Production Server dashboard is Installed
Execute the script
mps-dashboard with the
setup option, and when prompted, specify the
directory for dashboard setup. You must have write privileges to the
directory from where you are running the
script, and to the directory where the dashboard is going to be set
Script for Dashboard Setup
> mps-dashboard.bat setup Specify a workspace directory for MATLAB Production Server Dashboard: C:\mps\dashboard
$ ./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.
To directly specify a directory when setting up the dashboard, use the
-C option after the
option and provide a directory name.
For example, in Windows:
mps-dashboard.bat setup -C D:\mps\dashboard
For example, in Linux:
./mps-dashboard.sh setup -C /opt/mps/dashboard
For a complete list of options that can be passed to the
mps-dashboard script, pass a
as an option to the
For example, in Windows type:
> mps-dashboard.bat ?
In Linux, type:
$ ./mps-dashboard.sh ?
The complete list of options are as follows.
setup | start | stop | remove |
Troubleshooting (Windows only): If the
command fails with an error message that mentions a missing
MSVCR DLL, add
$MPS_ROOT\bin\win64 to your system
$MPS_ROOT is the
directory where you have MATLAB
Production Server installed. The
folder contains DLLs that MATLAB
Production Server uses.
mps-dashboard script with the
start option to start the dashboard.
Script to Start Dashboard
You will get a message indicating the host and port where the dashboard is
running. The default host and port are
Windows only: To run the dashboard instance as a background
process in Windows, precede the
mps-dashboard script with
> start /B mps-dashboard.bat
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:
Other customizations to the setup process can be made by editing
relevant parts of the
Open a web browser, and type the host and port number that were displayed in the previous step.
If you see garbled text in the dashboard logs, verify that the server machine
uses UTF-8 encoding. You must execute
again after setting the locale.
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.
Type the following information at the login screen for the username and password:
You are now logged into the MATLAB Production Server Dashboard.
You can use the
mps-dashboard script with the option
reset_admin_password to change the admin password.
Script to Reset the Admin Password
reset_admin_password option should not be executed
while dashboard is still running. First, stop dashboard execution using the
mps-dashboard script with the
option and then reset the admin password.