From 08c71132d45eb11713e9cc6605335fe7e517b45a Mon Sep 17 00:00:00 2001 From: xiconfjs Date: Wed, 20 Nov 2019 01:59:40 +0100 Subject: [PATCH] added README.md --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c171c0b --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# xtr + +This is the client for the XTR (XiCoN Trace Route). It opens a port and listening to HTTP requests. It answers with a traceroute in a json hash. The hash contains for each hop the IP, the PTR, the request time and the AS (Autonomous System) including the AS name. + +This client also tries to connect to a "master server" which helps keeping track of all the traceroute clients and their availability. + +This software uses the MaxMind GeoLite2 database (https://www.maxmind.com) to determine the AS for each hop. To lookup the AS information the script uses the MaxMind perl module which uses the MaxMind DB library. + +This product includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com. \ No newline at end of file