realtimetraffic/README.md

63 lines
2.0 KiB
Markdown
Raw Normal View History

2012-12-13 17:39:15 +01:00
# Realtime Traffic
Realtime Traffic is a Linux realtime trafic monitoring tool, graphing rx and tx of a Linux network interface in realtime to any modern web browser supporting WebSockets and SVG, developed at [struktur AG](http://www.strukturag.com)
2013-02-06 08:59:31 +01:00
![Screenshot](https://github.com/longsleep/realtimetraffic/raw/master/doc/screen4.png "Example Screenshot")
2012-12-13 17:39:15 +01:00
2012-12-13 19:12:13 +01:00
## Installation
Dowload the software, either using Git, or grab a [ZIP](https://github.com/longsleep/realtimetraffic/archive/master.zip) and extract it somewhere.
2014-03-09 16:53:21 +01:00
Getting started:
2012-12-13 19:12:13 +01:00
$ wget -O rtt.zip https://github.com/longsleep/realtimetraffic/archive/master.zip
$ unzip rtt.zip
$ cd realtimetraffic-master
2014-03-09 16:53:21 +01:00
$ make
2017-05-22 15:10:18 +02:00
$ ./bin/realtimetrafficd
2012-12-13 19:12:13 +01:00
Now just open up your browser:
$ firefox http://127.0.0.1:8088/?autostart=1
2014-03-09 16:53:21 +01:00
See the usage information (-h) for options.
2012-12-13 17:39:15 +01:00
2012-12-13 19:14:05 +01:00
## Server usage options
2012-12-13 19:12:13 +01:00
The trafficserver is basically a Websocket server pushing traffic data to any connected client.
```
2017-05-22 15:10:18 +02:00
Usage of ./bin/realtimetrafficd:
2014-03-09 16:53:21 +01:00
-listen="127.0.0.1:8088": Listen address.
2012-12-13 19:12:13 +01:00
```
2012-12-13 19:14:05 +01:00
## Client parameters
2012-12-13 19:12:13 +01:00
The client default parameters can be configured by URL query parameters.
```
2012-12-13 19:14:05 +01:00
url The trafficserver Websocket URL.
interf Inteface Name to capture the traffic (default eth0).
autostart Automatically connect to server on launch.
2012-12-13 19:12:13 +01:00
```
2012-12-13 17:39:15 +01:00
## Authors
This library was developed by Simon Eisenmann at [struktur AG](http://www.strukturag.com)
## License
2017-05-22 14:58:47 +02:00
Copyright (C) 2012-2017 struktur AG
2012-12-13 17:39:15 +01:00
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.