Thomas Frössman 9 gadus atpakaļ
vecāks
revīzija
8874b5ed6e
1 mainītis faili ar 18 papildinājumiem un 25 dzēšanām
  1. 18
    25
      README.md

+ 18
- 25
README.md Parādīt failu

@@ -1,35 +1,28 @@
1 1
 # internet :) [![Build Status](https://drone.io/github.com/thomasf/internet/status.png)](https://drone.io/github.com/thomasf/internet/latest)
2 2
 
3
+This package contains a server and client for historical searches in bgp dumps.
4
+I'm not sure where this is going so for the moment this package is named
5
+internet to postpone the definition.
3 6
 
4
-This package contains a server and client for historical searches in bgp dumps. I'm not sure where this is going so for the moment this package is named internet to postpone the definition.
7
+## Features
5 8
 
6
-The first two things to be implemented are ports of the core functionality in  https://github.com/CIRCL/IP-ASN-history and https://github.com/CIRCL/ASN-Description-History .
9
+* Downloads BGP table dumps from http://data.ris.ripe.net/rrc00 and imports
10
+  them into redis for current and historical IP address to AS Number lookup.
11
+* Downloads http://www.cidr-report.org/as2.0/autnums.html (controlled to once
12
+  per day) and stores the entries in redis for current and historical AS Number
13
+  to AS Description lookup.
14
+* Caches all data downloads so that databases can be rebuilt easily.
7 15
 
8 16
 
9
-## pre requirements
17
+## Pre requirements
10 18
 
11
-Download and install bgpdump: http://www.ris.ripe.net/source/bgpdump/
12
-
13
-
14
-## whats done
15
-
16
-* download bgpdump by date
17
-* import downloaded bgpdump files
18
-* query full ip2asn history
19
-* add query for latest imported date only
20
-
21
-## todo (shortlist)
22
-* add ASN2Description support.
23
-* add dump update scheduling function suitable to be integrated into a query server
24
-* replace cmd/dev with an example
25
-* write tests
26
-* final API design
27
-* improve docs
28
-
29
-# maybe/later
30
-
31
-* add query for specific date lookup
32
-* support removing old dates (could it be better to just rebuild from a separate redis db?)
19
+* BGPDump - [Download](http://www.ris.ripe.net/source/bgpdump/), compile and
20
+  install it somewhere into PATH.
21
+* Redis
33 22
 
34 23
 
24
+## Acknowledgments
35 25
 
26
+Basic design for the IP2ASN history and ASN2ASDescription parts were inspired
27
+from https://github.com/CIRCL/IP-ASN-history and
28
+https://github.com/CIRCL/ASN-Description-History .