Skip to content

Commit 879eb5a

Browse files
authored
Update README.md
1 parent 87d5ae5 commit 879eb5a

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,19 @@ String host = "localhost";
1010
TinyReverseProxy reverseProxy = new TinyReverseProxy(host, port);
1111

1212
//Add paths - SEPIA defaults for custom-bundle:
13-
reverseProxy.addPrefixPath("/sepia/assist", "http://localhost:20721");
14-
reverseProxy.addPrefixPath("/sepia/teach", "http://localhost:20722");
15-
reverseProxy.addPrefixPath("/sepia/chat", "http://localhost:20723");
13+
boolean isPublic = true; //allows access from public and local IPs
14+
reverseProxy.addPrefixPath("/sepia/assist", "http://localhost:20721", isPublic);
15+
reverseProxy.addPrefixPath("/sepia/teach", "http://localhost:20722", isPublic);
16+
reverseProxy.addPrefixPath("/sepia/chat", "http://localhost:20723", isPublic);
1617

1718
//Start proxy
1819
reverseProxy.start();
1920
```
21+
SSL is supported and can for example be used with Letsencrypt certificates, you just need to convert them to a Java key-store. See this [bash script](https://github.com/SEPIA-Framework/sepia-installation-and-setup/blob/master/sepia-custom-bundle-folder/letsencrypt/copy-cert-to-keystore.sh) for an example.
2022

21-
Be sure to check-out the source to tweak the number of possible threads for more performance.
23+
Hostname, port and proxy paths can be configured via the `proxy.properties` file in `settings`.
24+
25+
Before using: Be sure to check-out the source to tweak the number of possible threads for more performance. If you use the IP filter for local addresses make sure that there is NO OTHER proxy in front otherwhise all your IPs will be local and the filter will NOT WORK!
2226

2327
Good to know: Thanks to Undertow it also works as proxy for WebSocket servers out-of-the-box :-)
2428

25-
### To-do
26-
Introduce a config-file and maybe some command-line options to handle custom path-to-target mappings.

0 commit comments

Comments
 (0)