Skip to content

Commit bd9f6a1

Browse files
authored
Update README
1 parent dd7c084 commit bd9f6a1

1 file changed

Lines changed: 23 additions & 6 deletions

File tree

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Proxy for MATLAB Parallel Server™
22

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.
44
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.
55

66
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
2929
`parallelserverproxy [<args>]` starts a proxy server using the specified input arguments.
3030
- `args` - Inputs to the proxy server.
3131

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.
3348
```
3449
parallelserverproxy -port 1080 -certificate "proxy-certificate.json"
35-
Starting SOCKS5 proxy on socks5s://*:1080
3650
```
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.
3956

4057
To display the help text for parallelserverproxy, run
4158
```
@@ -98,4 +115,4 @@ The license is available in the [license.txt](license.txt) file in this reposito
98115

99116
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).
100117

101-
Copyright 2024-2025 The MathWorks, Inc.
118+
Copyright 2024-2026 The MathWorks, Inc.

0 commit comments

Comments
 (0)