From 9709d299782a685da7c51ceb8e39b4029133c72b Mon Sep 17 00:00:00 2001 From: amir gh Date: Mon, 9 Oct 2023 23:43:01 -0700 Subject: [PATCH] change readme to add collector flag --- x/examples/outline-connectivity/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/x/examples/outline-connectivity/README.md b/x/examples/outline-connectivity/README.md index 4cbff394..92adc916 100644 --- a/x/examples/outline-connectivity/README.md +++ b/x/examples/outline-connectivity/README.md @@ -1,12 +1,14 @@ # Outline Connectivity Test -This app illustrates the use of the Shadowsocks transport to resolve a domain name over TCP or UDP. +This app illustrates the use of the Shadowsocks transport to resolve a domain name over TCP or UDP. If report collector is specified, it will send a report to the collector if connectivity error occurs. Example: ``` # From https://www.reddit.com/r/outlinevpn/wiki/index/prefixing/ KEY=ss://ENCRYPTION_KEY@HOST:PORT/ +# Example report collector setup: https://github.com/amircybersec/report-collector +COLLECTOR_URL=https://server-address.com/ for PREFIX in POST%20 HTTP%2F1.1%20 %05%C3%9C_%C3%A0%01%20 %16%03%01%40%00%01 %13%03%03%3F %16%03%03%40%00%02; do - go run github.com/Jigsaw-Code/outline-sdk/x/examples/outline-connectivity@latest -transport="$KEY?prefix=$PREFIX" -proto tcp -resolver 8.8.8.8 && echo Prefix "$PREFIX" works! + go run github.com/Jigsaw-Code/outline-sdk/x/examples/outline-connectivity@latest -transport="$KEY?prefix=$PREFIX" -proto tcp -resolver 8.8.8.8 -collector $COLLECTOR_URL && echo Prefix "$PREFIX" works! done ```