Set Up and Log In to MATLAB Production Server Admin Portal

R2026b

Follow these instructions to set up, start, and log in to the Admin Portal for an on-premises installation of MATLAB® Production Server™. You can use the Admin Portal to manage a server instance.

Prerequisites

  • An installation of MATLAB Runtime

  • A version of MATLAB Production Server that is compatible with your MATLAB Runtime installation

Create a Server Instance

  1. Run the mps-setup command from your install location. Replace <install_root> with the install folder.

    <install_root>/script/mps-setup
    This allows you to specify the MATLAB Runtime your server instance will use.

    Note

    If you are using Windows®, run the mps-setup command as an administrator. Do not, however, run mps-portal as an administrator.

  2. Then, create a new instance of MATLAB Production Server using mps-new. 

    <install_root>/script/mps-new <mps_instance>
    For more information, see Create Server Instance Using Command Line.

Create and Configure Certificates

  1. To generate a certificate chain and private key for your MATLAB Production Server instance, use the mps-cert command.

    <install_root>/script/mps-portal mps-cert -C <mps_instance>

  2. Copy the generated files into the <mps_instance>\x509 folder.

    Note

    If you are using a newly generated certificate authority, ensure that you have added it to your trust store.

Set Up Admin Portal

  1. Open a terminal or command window and navigate to the scripts folder of your MATLAB Production Server installation.

  2. Execute the mps-portal command with the setup option. 

    <install_root>/script/mps-portal setup -C <mps_instance>

    Note

    Do not run admin portal services as an administrator on Windows or as a superuser on Linux®. This causes permissions issues when modifying files.

    This creates the /admin directory in your MATLAB Production Server instance folder, which contains the config files and logs for the Admin Portal.

Configure Access Control

  1. Register an application with an identity provider of your choice. For more about supported identity providers, see Application Access Control.

  2. Use the mps-portal command with the start option to start your server and its associated Admin Portal.

    <install_root>/script/mps-portal start -C <mps_instance>

    This command generates a URL to the Admin Portal welcome page, which provides an interface for generating the files portal_authn.json and prodserver_admin_authz.json, which specify the access control policy and the identity provider, respectively. The URL will have the following format:

    http://<hostname>:<port>/mps/welcome

    Move portal_authn.json to the /admin/portal folder and prodserver_admin_authz.json to the /admin/api folder, both under your MATLAB Production Server instance folder.

  3. Edit the portal_authn.json file, specifying values for the issuer, clientId, clientSecret,redirectUrl, and scope based on information provided by your identity provider.

  4. Edit the prodserver_admin_authz.json file, populating the email field for "id" : "adminsaccessall" with your email address.

Log In to Admin Portal

  1. Restart the server by using the admin-portal command with the restart option.

    <install_root>/script/mps-portal restart -C <mps_instance>

  2. Open a web browser, and copy the URL displayed by the mps-portal command. The URL has the following format:

    http://<hostname>:<port>/mps/overview

See Also

Topics