Main Content

Core Management Tasks

Create and run a server that hosts deployable archives

You can create, start, and stop MATLAB® Production Server™ instances from the command line. Use the configuration properties to tailor each instance to a specific task or use. If you make changes to the configuration properties for a server that is already running, you must restart it for the changes to take effect.

Properties

expand all

httpURL for insecure connections
http-linger-thresholdAmount of data the server instance discards after an HTTP error and before the server instance closes the TCP connection
mcr-rootLocation of a MATLAB Runtime installation
auto-deploy-rootFolder that the server instance scans for deployable archives
extract-rootRoot folder used to store contents of deployed archives
async-deploy-on-startupDeploy archives after the server starts
num-workersMaximum number of workers allowed to process work simultaneously
worker-restart-intervalTime interval at which server instance stops and restarts workers
worker-restart-memory-limitSize threshold at which to consider restarting a worker
worker-restart-memory-limit-intervalInterval for which a worker can exceed its memory limit before restart
worker-memory-check-intervalInterval at which workers are polled for memory usage
cors-allowed-originsSpecify the domain origins from which clients are allowed to make requests to the server
request-timeoutDuration after which the request times out and gets deleted after reaching a terminal state
response-archive-rootPath to the location where responses are archived
response-archive-limitMaximum disk space available to the server process for archiving
server-memory-thresholdSize threshold of server process at which action needs to be taken to manage responses
server-memory-threshold-overflow-actionAction taken when the memory size threshold of server process is breached
disable-control-cDisable keyboard interruptions for server instance
enable-graceful-shutdownGracefully shut down server processes after receiving a terminal interrupt signal or program termination signal
main-log-formatText format for the main log file
num-threadsNumber of request-processing threads within the server instance
request-size-limitSet the maximum size of a request
server-termination-grace-periodDuration after which all server instance processes are forcibly terminated
user-dataAssociate MATLAB data value with string key
use-single-comp-threadStart MATLAB Runtime with a single computational thread

Command-Line Scripts for Windows, Linux, and macOS

mps-setupSet up server environment from command line on Windows, Linux, and macOS systems
mps-newCreate server instance from command line on Windows, Linux, and macOS systems
mps-startStart server instance from command line on Windows, Linux, and macOS systems
mps-stopStop server instance from command line on Windows, Linux, and macOS systems
mps-restartStop and start server instance from command line on Windows, Linux, and macOS systems
mps-serviceCreate or modify Windows service for server instance from command line on Windows systems
mps-cacheControl persistence service from command line on Windows, Linux, and macOS systems

Topics

Server Basics

Start and Stop Server Instance

MATLAB Runtime Settings

Server Configuration