added README.md

This commit is contained in:
xiconfjs 2019-11-20 01:59:40 +01:00
parent f76452b80e
commit 08c71132d4
1 changed files with 9 additions and 0 deletions

9
README.md Normal file
View File

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