Package: matlab-proxy
MATLAB Proxymatlab-proxyis a Python® package which enables you to launch MATLAB® and access it from a web browser.Installation of this package creates an executablematlab-proxy-app, which launches MATLAB and provides a URL to access it.The MATLAB Proxy is under active development. For support or to report issues, see theFeedbacksection.Table of ContentsRequirementsInstallationPyPIBuilding From SourcesUsageExamplesLimitationsSecurityFeedbackRequirementsMATLAB® R2020b or later is installed and on the system PATH.# Confirm MATLAB is on the PATHwhichmatlabThe dependencies required to run MATLAB.
Refer to the Dockerfiles in thematlab-depsrepository for the desired version of MATLAB.X Virtual Frame Buffer (Xvfb) : (only for Linux® based systems)Install it on your linux machine using:# On a Debian/Ubuntu based system:$sudoaptinstallxvfb# On a RHEL based system:$yumsearchXvfb
xorg-x11-server-Xvfb.x86_64:AXWindowsSystemvirtualframebufferXserver.

$sudoyuminstallxorg-x11-server-XvfbNote: The installation of Xvfb isoptional(w.e.f. v0.11.0 of matlab-proxy). However, we highly recommend installing it.Python versions:3.8|3.9|3.10|3.11Browser RequirementsSupported Operating Systems:Linux®Windows® Operating System ( starting v0.4.0 of matlab-proxy )MacOS (starting v0.5.0 of matlab-proxy )SeePlatform Supportfor more informationInstallationPyPIThis repository can be installed directly from the Python Package Index.python-mpipinstallmatlab-proxyBuilding From SourcesBuilding from sources requires Node.js® version 16 or higher.Click here to install Node.jsgitclonehttps://github.com/mathworks/matlab-proxy.gitcdmatlab-proxy

python-mpipinstall.Installing the package creates an executable calledmatlab-proxy-app, which is placed onto your system PATH bypip, usually in:$HOME/.local/bin/# Confirm it is on the PATHwhichmatlab-proxy-appUsageOnce thematlab-proxypackage is installed.Open a Linux terminal and launch the application withenvMWI_BASE_URL="/matlab"matlab-proxy-appMWI_BASE_URLis an environment variable which controls the link on which MATLAB can be accessed.
For a detailed listing of all environment variables. SeeAdvanced-Usage.mdRunning the above command will print text out on your terminal, which will contain the URL to access MATLAB. For example:Access MATLAB at 
http://localhost:44549/matlab/index.htmlOpen the the link above in a web browser. If prompted to do so, enter credentials for a MathWorks account associated with a MATLAB license. If you are using a network license manager, then change to theNetwork License Managertab and enter the license server address instead. To determine the appropriate method for your license type, consultMATLAB Licensing Info.Wait for the MATLAB session to start.This can take several minutes.To manage the MATLAB session, click the tools icon shown below.Clicking the tools icon opens a status panel with buttons like the ones below:The following options are available in the status panel (some options are only available in a specific context):OptionDescriptionStart MATLABStart your MATLAB session. Available if MATLAB is stopped.Restart MATLABRestart your MATLAB session. Available if MATLAB is running or starting.Stop MATLABStop your MATLAB session. Use this option if you want to free up RAM and CPU resources. Available if MATLAB is running or starting.Sign OutSign out of MATLAB session. Use this to stop MATLAB and sign in with an alternative account. Available if using online licensing.Unset License Server AddressUnset network license manager server address. Use this to stop MATLAB and enter new licensing information. Available if using network license manager.FeedbackProvide feedback. Opens a new tab to create an issue on GitHub.HelpOpen a help pop-up for a detailed description of the options.ExamplesFor installing/usage in a Docker container, see thisDockerfileand itsREADME.For upgradingmatlab-proxyin an existing Docker image, see thisDockerfile.upgrade.matlab-proxyand itsREADME.*For usage in a Jupyter environment, seejupyter-matlab-proxy.Platform SupportLinuxThis package is fully supported for the Linux Operating System.WindowsWindows® Operating System support was introduced in package versionv0.4.0.
Install the version >=0.4.0 to use the package on Windows.# To upgrade an existing installation of matlab-proxy package:$pipinstall--upgradematlab-proxy>=0.4.0MacOSMacOS support was introduced in package versionv0.5.0.
It works best for MATLAB versions newer than R2022b.
Note: Figuresalsoopen in a separate windows on versions of MATLAB older than R2022b.Install the version >=0.5.0 to use the package on MacOS.# To upgrade an existing installation of matlab-proxy package:$pipinstall--upgradematlab-proxy>=0.5.0Windows Subsystem for Linux (WSL 2)To installmatlab-proxyin WSL 2, follow the steps mentioned in theInstallation Guide for WSL 2.Using an already activated MATLAB with matlab-proxymatlab-proxyversionv0.7.0introduces support for using an existing MATLAB license. Use the Existing License option only if you have an activated MATLAB. This allows you to start MATLAB without authenticating every time.LimitationsThis package supports the same subset of MATLAB features and commands as MATLAB® Online, except there is no support for Simulink® Online.Click here for a full list of Specifications and Limitations for MATLAB Online.SecurityWe take your security concerns seriously, and will attempt to address all concerns.matlab-proxyuses several other python packages, and depend on them to fix their own vulnerabilities.All security patches will be released as a new version of the package.
Patches are never backported to older versions or releases of the package.
Using the latest version will provide the latest available security updates or patches.FeedbackWe encourage you to try this repository with your environment and provide feedback.
If you encounter a technical issue or have an enhancement request, create an issuehereCopyright 2020-2024 The MathWorks, Inc.