|
1 | 1 | # Proxy for MATLAB Parallel Server™ |
2 | 2 |
|
3 | | -Use the parallelserverproxy to start a proxy server which can proxy all traffic between a MATLAB® client and a MATLAB Parallel Server cluster. |
| 3 | +Use the parallelserverproxy to start a proxy server which can proxy all traffic between a MATLAB® client and a MATLAB Job Scheduler cluster. |
4 | 4 | This can be used to create a single access point for the cluster on the host where the parallelserverproxy is run and via the port specified. |
5 | 5 |
|
6 | 6 | The parallelserverproxy uses the SOCKS protocol to allow connecting clients to specify the destination to connect to. Authentication of connecting clients is provided by |
@@ -29,13 +29,30 @@ You can download pre-compiled binaries for Linux® and Windows® from the |
29 | 29 | `parallelserverproxy [<args>]` starts a proxy server using the specified input arguments. |
30 | 30 | - `args` - Inputs to the proxy server. |
31 | 31 |
|
32 | | -Once connected, the url clients use to connect to the proxy is printed. For example: |
| 32 | +Before starting the proxy, install the `mjssetup` tool from the [mjssetup GitHub repository](https://github.com/mathworks/mjssetup). |
| 33 | +Create a secret file using the `mjssetup` tool. |
| 34 | +For example, create a shared secret file with the name "secret.json". |
| 35 | +``` |
| 36 | +mjssetup create-shared-secret -outfile "secret.json" |
| 37 | +``` |
| 38 | + |
| 39 | +Generate a signed certificate from the shared secret using the `mjssetup` tool. |
| 40 | +For example, from the shared secret file "secret.json", generate a signed certificate "proxy-certificate.json". |
| 41 | +``` |
| 42 | +mjssetup generate-certificate -secretfile "secret.json" -outfile "proxy-certificate.json" |
| 43 | +``` |
| 44 | + |
| 45 | +Start the SOCKS5 proxy server. |
| 46 | +For example, start a server that listens on port 1080 and uses the signed certificate file "proxy-certificate.json". |
| 47 | +When the proxy server starts, `parallelserverproxy` displays the URL template for the proxy server. |
33 | 48 | ``` |
34 | 49 | parallelserverproxy -port 1080 -certificate "proxy-certificate.json" |
35 | | -Starting SOCKS5 proxy on socks5s://*:1080 |
36 | 50 | ``` |
37 | | -Connecting clients should then specify the proxy url as `socks5s://<proxyHost>:1080` to access the cluster via the proxy, where |
38 | | -proxyHost should be replaced with the resolvable hostname or IP address of the machine running the proxy server. |
| 51 | +`SOCKS5 proxy ready to accept connections at: socks5s://*:1080` |
| 52 | + |
| 53 | +To connect to MATLAB Job Scheduler via the proxy server, MATLAB clients must have a corresponding client certificate file signed with the cluster secret file for authentication. |
| 54 | +You can create a certified profile that incorporates the signed certificate file and the proxy URL to enable clients to connect to the cluster. |
| 55 | +For instructions, see [Configure SOCKS5 Proxy for MATLAB Job Scheduler](https://www.mathworks.com/help/matlab-parallel-server/configure-socks5-proxy-for-matlab-job-scheduler.html) on the MathWorks website. |
39 | 56 |
|
40 | 57 | To display the help text for parallelserverproxy, run |
41 | 58 | ``` |
@@ -98,4 +115,4 @@ The license is available in the [license.txt](license.txt) file in this reposito |
98 | 115 |
|
99 | 116 | If you require assistance or have a request for additional features or capabilities, contact [MathWorks Technical Support](https://www.mathworks.com/support/contact_us.html). |
100 | 117 |
|
101 | | -Copyright 2024-2025 The MathWorks, Inc. |
| 118 | +Copyright 2024-2026 The MathWorks, Inc. |
0 commit comments