commit f0eed4f4d4a55dde690844df4985bddef781b127 Author: Peter Evjan <peter.evjan@gmail.com> Date: Tue Jan 1 18:06:49 2013 +1100 Added instructions for how to run a local Atlas server --- Readme.rst | 17 +++++++++++++++++ 1 files changed, 17 insertions(+), 0 deletions(-) diff --git a/Readme.rst b/Readme.rst index c5cac71..bb31355 100644 --- a/Readme.rst +++ b/Readme.rst @@ -5,3 +5,20 @@ Tor Status is a web application to discover Tor relays and bridges. It provides information on how relays are configured along with graphics about their past. +Running it +---------- + +You need to have Python and Tornado installed to run the web server locally. The easiest +way of installing Tornado is: + +:: + + sudo easy_install tornado + +Once that is done, you can run the server with the following command: + +:: + + python run.py + +After which, the Atlas site will be available on http://localhost:8888/index.html \ No newline at end of file