How do I upgrade MATLAB Web App Server to a new release?

How do I upgrade my existing MATLAB Web App Server installation to a newer release, and keep my configuration the same? 

Answer 1

[MathWorks Support Team]

1. Update your license manager if you have not already

First, ensure your Network License Manager is up to date and is hosting the most recent version of your license. For instructions on how to do so, please see the following:

How do I update the Network License Manager?

https://www.mathworks.com/matlabcentral/answers/514971

 

2. Stop the current MATLAB Web App Server

You can stop Web App Server using the webapps-stop script located in the /script directory of your Web App Server installation directory. See the following default directories (replace R20XXx with your current release, i.e. R2021b):

Windows

C:\Program Files\MATLAB\MATLAB Web App Server\R20XXx\script

Linux

/usr/local/MATLAB/MATLAB_Web_App_Server/R20XXx/script

macOS (Intel processor)

/Applications/MATLAB/MATLAB_Web_App_Server/R20XXx/script

Please note these scripts need to be run as an administrator or with sudo. 

 

3. Download and install the newer release of Web App Server, and any runtimes if needed

For downloading/installing MATLAB Web App Server, please see the instructions in the following article:

How do I setup MATLAB Web App Server?

https://www.mathworks.com/matlabcentral/answers/519454

If you have newer apps that were created with newer versions of MATLAB Runtime, please also download and install the appropriate Runtime from the following page:

https://www.mathworks.com/products/compiler/matlab-runtime.html

 

4. Run webapps-setup 

Set up the new release of MATLAB Web App Server using the webapps-setup script. Do not run webapps-start yet after completing setup. Please see the following documentation for additional details:

Set up MATLAB Web App Server

If you additionally need to set up SSL, please do so as well. See the following documentation for additional details:

Enable SSL

 

5. Move apps over, and authentication files

Copy the apps and authentication files to their respective locations:

Windows

Apps: %ProgramData%\MathWorks\webapps\R20YYy\apps

Authentication: %ProgramData%\MathWorks\webapps\R20YYy\config\webapps_private

Linux

Apps: /local/MathWorks/webapps/R20YYy/apps

Authentication: /local/MathWorks/webapps/R20YYy/config\webapps_private

macOS (Intel processor)

Apps: /Library/Application Support/MathWorks/webapps/R20YYy/apps

Authentication: /Library/Application Support/MathWorks/webapps/R20YYyconfig\webapps_private

Important: Do not copy over the *.config files from the previous release. These get regenerated for the new release.

6. Set up config manually 

At the moment, the webapps.config is release-specific. It is not guaranteed to be backwards or future-compatible. 

To migrate your config, the preferred way is to use webapps-config utility. You can either record all of the steps you took to configure your old server in a shell script and replay it against the new server, or write a simple shell script that reads all the settings in the old server using "webapps-config get", iterates over them and apply to the new server using "webapps-config set <key> <value>" syntax.

Note that some paths may have to be tweaked in the process . You may need to review "webapps-runtime list" output from your old server as well and decide which runtimes should be added to the new server as well using "webapps-runtime add" command.

If you have done any manual modifications to webapps.config, those will need to be applied manually to the new server version of webapps.config. 

 

7. Start the new Web App Server instance

Use the webapps-start script to start the new instance of MATLAB Web App Server.