From 879eb5ae6b0a1f2c9f1db59ec6860c1b88a5c404 Mon Sep 17 00:00:00 2001 From: Florian Quirin Date: Sat, 18 Aug 2018 15:05:23 +0200 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5c4c63b..59fec38 100644 --- a/README.md +++ b/README.md @@ -10,17 +10,19 @@ String host = "localhost"; TinyReverseProxy reverseProxy = new TinyReverseProxy(host, port); //Add paths - SEPIA defaults for custom-bundle: -reverseProxy.addPrefixPath("/sepia/assist", "http://localhost:20721"); -reverseProxy.addPrefixPath("/sepia/teach", "http://localhost:20722"); -reverseProxy.addPrefixPath("/sepia/chat", "http://localhost:20723"); +boolean isPublic = true; //allows access from public and local IPs +reverseProxy.addPrefixPath("/sepia/assist", "http://localhost:20721", isPublic); +reverseProxy.addPrefixPath("/sepia/teach", "http://localhost:20722", isPublic); +reverseProxy.addPrefixPath("/sepia/chat", "http://localhost:20723", isPublic); //Start proxy reverseProxy.start(); ``` +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. -Be sure to check-out the source to tweak the number of possible threads for more performance. +Hostname, port and proxy paths can be configured via the `proxy.properties` file in `settings`. + +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! Good to know: Thanks to Undertow it also works as proxy for WebSocket servers out-of-the-box :-) -### To-do -Introduce a config-file and maybe some command-line options to handle custom path-to-target mappings.