From e2283081cd7c35450a600ba4e102dde6579e4b7f Mon Sep 17 00:00:00 2001 From: xiconfjs Date: Wed, 20 Nov 2019 02:02:24 +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..e9a2b7f --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# xtr + +This is the server for the XTR (XiCoN Trace Route). It's more of a master browser for the clients, so an web frontend can get a list of all the available clients combined from one auto-updated source. It opens a port and listening to HTTP requests (GET and PUT). It can list all online and offline clients. It also accepts new client entries via a PUT request (target client address in database has to be the request ip). + +The server keeps the list of clients up2date with checking their availablity with each request of all online clients. + +This software uses the iptoasn database (https://iptoasn.com/) to determine the AS for each client. To keep track of all ip to asn relations, this software creates a local database file "ip2asn.db", which is a simple SQLite3 database with an index for faster searches. + +For now, only IPv4 clients are supported. This will change in the future. \ No newline at end of file