From cdd5a24f27eb15a3cf2ed2d332f02ef28ce69fb6 Mon Sep 17 00:00:00 2001 From: Simon Eisenmann Date: Thu, 13 Dec 2012 19:12:13 +0100 Subject: [PATCH] Updated docs --- README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 47 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 69e8ecc..38f0df5 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,62 @@ Realtime Traffic is a Linux realtime trafic monitoring tool, graphing rx and tx ![Screenshot](//github.com/longsleep/realtimetraffic/raw/master/doc/screen4.png "Example Screenshot") +## Installation + +Dowload the software, either using Git, or grab a [ZIP](https://github.com/longsleep/realtimetraffic/archive/master.zip) and extract it somewhere. + +You can use the client right away without installation. Just open the file client/realtimetraffic.html in any modern browser, type in a WebSocket address of a server you started somewhere and press start. + +To install the server, make sure you have [Python](http://www.python.org) (2.5, 2.6, 2.7 tested) and [tornado](http://pypi.python.org/pypi/tornado). For Python << 2.6 you also need [simplejson](http://pypi.python.org/pypi/simplejson). Then just startup the server. + +On Ubuntu this is simple like this: + + $ wget -O rtt.zip https://github.com/longsleep/realtimetraffic/archive/master.zip + $ unzip rtt.zip + $ cd realtimetraffic-master + $ sudo apt-get install python-tornado + $ python trafficserver/trafficserver.py + Server running on 127.0.0.1:8088 (ssl:False) ... + +Now just open up your browser: + + $ firefox http://127.0.0.1:8088/?autostart=1 + ## Getting Started Startup the traffice server on a Linux machine of your choice. -``` - python trafficserver/trafficserver.py -``` + $ python trafficserver/trafficserver.py And open up the server's web page (http://yourserver:8088/). See the usage information (--help) for options. +## Options + +The trafficserver is basically a Websocket server pushing traffic data to any connected client. + +``` + Usage: trafficserver.py [options] + + Options: + -h, --help show this help message and exit + -l LISTEN, --listen=LISTEN + listen address (default: [127.0.0.1:8088]) + --ssl_keyfile=FILE SSL key file + --ssl_certfile=FILE SSL certificate file +``` + +## Parameters + +The client default parameters can be configured by URL query parameters. + +``` + url The trafficserver Websocket URL. + interf Inteface Name to capture the traffic (default eth0). + autostart Automatically connect to server on launch. +``` + ## Authors This library was developed by Simon Eisenmann at [struktur AG](http://www.strukturag.com)