Skip to content

Changed the project's README file to work with GitHub's mark-down and included basic usage information. #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tor-hound wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Changed the project's README file to work with GitHub's mark-down and included basic usage information. #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4de4b7c
Create README.md
tor-hound May 22, 2015
9527b1b
Delete README
tor-hound May 22, 2015
10160a5
Updated to eliminate the reference to the parent project and clarify …
tor-hound Jul 9, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file removed README
View file
Open in desktop
Empty file.
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Orchid
======

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
-----

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

Note that on some systems, netcat is delivered with the name "nc" so the above command would
be changed as follows:

nc localhost 10000