From 4de4b7cfbe578abeb471d30db0faef1fd48f65e9 Mon Sep 17 00:00:00 2001 From: Torbjorn Hulda Date: Fri, 22 May 2015 18:44:07 +0000 Subject: [PATCH 1/3] Create README.md --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..88981d32 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +Orchid +====== + +The Orchid TOR library is a pure Java implementation of the TOR protocol. This repository +was cloned from subgraph/Orchid. The library also provides a built-in TOR-enabled proxy +server. The remainder of this file describes using the library - see the javadocs for +details on integrating it with your Java program. + +Usage +----- + +Starting Orchid is pretty easy. Using Java 1.5 or greater, simply point your browser (or +other HTTP client) to localhost:9150. If you also want the dashboard to be exposed, launch +Orchid using the following command: + + java -Dcom.subgraph.orchid.dashboard.port=10000 -jar orchid-1.0.0.jar + +Dashboard +--------- + +Viewing the dashboard can be accomplished with any "TCP listener". From the CLI, the easiest +way to watch the dashboard is to use NetCat as follows: + + netcat localhost 10000 From 9527b1b169875fff93376af72438609b6a0cbd30 Mon Sep 17 00:00:00 2001 From: Torbjorn Hulda Date: Fri, 22 May 2015 18:46:29 +0000 Subject: [PATCH 2/3] Delete README --- README | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 README diff --git a/README b/README deleted file mode 100644 index e69de29b..00000000 From 10160a56272b820668bd29c9665e986c0d88de37 Mon Sep 17 00:00:00 2001 From: Torbjorn Hulda Date: Thu, 9 Jul 2015 15:03:01 +0000 Subject: [PATCH 3/3] Updated to eliminate the reference to the parent project and clarify the netcat usage. --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 88981d32..660c1d08 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,9 @@ Orchid ====== -The Orchid TOR library is a pure Java implementation of the TOR protocol. This repository -was cloned from subgraph/Orchid. The library also provides a built-in TOR-enabled proxy -server. The remainder of this file describes using the library - see the javadocs for -details on integrating it with your Java program. +The Orchid TOR library is a pure Java implementation of the TOR protocol. The library also +provides a built-in TOR-enabled proxy server. The remainder of this file describes using the +library - see the javadocs for details on integrating it with your Java program. Usage ----- @@ -22,3 +21,8 @@ Viewing the dashboard can be accomplished with any "TCP listener". From the CLI way to watch the dashboard is to use NetCat as follows: netcat localhost 10000 + +Note that on some systems, netcat is delivered with the name "nc" so the above command would +be changed as follows: + + nc localhost 10000