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

  • An OIDC identity provider

  • Trusted SSL certificates

Create a Server Instance

  1. Note

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

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

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

  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-cert -C <mps_instance>

    Replace <mps_instance> with the full path to the server instance directory.

  2. The generated certificate files are created in the <mps_instance>/x509 folder. Update the main_config server configuration file in <mps_instance>/config/main_config to use the generated certificates. Set the following properties:

    1. Set --x509-private-key to ./x509/server_key.pem.

    2. Set --x509-cert-chain to ./x509/server_cert.pem.

    3. Set --https to the desired HTTPS port number.

    Note

    If you are using a newly generated certificate authority, import the server_ca_cert.pem file from the <mps_instance>/x509 folder into your trust store.

Set Up Admin Portal

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.

  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>

    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 for Admin Portal

  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. The URL will have the following format:

    https://<hostname>:<port>/welcome

  3. Open the welcome page in a web browser. Use the interface to select your identity provider and specify values for the issuer, clientId, and clientSecret based on information provided by your identity provider. The redirectUrl and scope fields are pre-populated based on your identity provider selection.

    Populate the user attribute for "id" : "adminsaccessall" with the identifier of the administrator. The user attribute depends on the identity provider.

  4. Download the generated portal_authn.json and prodserver_admin_authz.json files from the welcome page. These files contain the access control policy and identity provider configuration, respectively.

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

Log In to Admin Portal

  1. Restart the Admin Portal by using the mps-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:

    https://<hostname>:<port>/overview

See Also

Topics