Set Up and Log In to MATLAB Production Server Dashboard

Follow these instructions to set up the dashboard for an on-premises installation of MATLAB® Production Server™.

Set Up the Dashboard

Warning

You must have admin privileges on Windows® to complete setup.

To set up an instance of the MATLAB Production Server dashboard:

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

    Platform

    Default Directory Where the MATLAB Production Server dashboard is Installed

    Windows (Administrator)

    C:\Program Files\MATLAB\MATLAB Production Server\R2020b\dashboard

    Linux®

    /usr/local/MATLAB/MATLAB_Production_Server/R2020b/dashboard

  2. 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 mps-dashboard script, and to the directory where the dashboard is going to be set up.

    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

    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, in Windows: > mps-dashboard.bat setup -C D:\mps\dashboard

    For example, in Linux: $ ./mps-dashboard.sh setup -C /opt/mps/dashboard

    Note

    For a complete list of options that can be passed to the mps-dashboard script, pass a ? as an option to the mps-dashboard script.

    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 | reset_admin_password

    Tip

    Troubleshooting (Windows only): If the mps-dashboard.bat setup command fails with an error message that mentions a missing MSVCR DLL, add $MPS_ROOT\bin\win64 to your system PATH, where $MPS_ROOT is the directory where you have MATLAB Production Server installed. The $MPS_ROOT\bin\win64 folder contains DLLs that MATLAB Production Server uses.

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

    Platform

    Script to Start Dashboard

    Windows (Administrator)

    > mps-dashboard.bat start

    Linux

    $ ./mps-dashboard.sh start

    You will get a message 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\R2020b\dashboard\config\config.txt

    Linux

    /usr/local/MATLAB/MATLAB_Production_Server/R2020b/dashboard/config/config.txt

    Other customizations to the setup process can be made by editing relevant parts of the config.txt file.

  4. Open a web browser, and type the host and port number that were displayed in the previous step.

    For example:

    http://localhost:9090 

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 on Microsoft Windows Platforms (MATLAB) and Set Locale on Linux Platforms (MATLAB).

Log In to the Dashboard

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

  1. 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

  2. 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 the Admin Password

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

Platform

Script to Reset the Admin Password

Windows (Administrator)

> mps-dashboard.bat reset_admin_password

Linux

$ ./mps-dashboard.sh reset_admin_password

Warning

The reset_admin_password option should not be executed while dashboard is still running. First, stop dashboard execution using the mps-dashboard script with the stop option and then reset the admin password.

Related Topics