Readme + GPLv3 licensing

README.md

@@ -0,0 +1,24 @@
+# dnmapper - An AS-level mapping tool and BGP collector
+
+This software 
+There is much to do! This software was in parts a quick hack to have a map
+when the old map implementation vanished from our network.
+It is implemented in Python, Django and D3.js.
+
+## Data collection
+Data collection is done via screenscraping the BIRD and Quagga/FRR cli. This is
+a bad idea for longterm operations, as a) the CLI output may (and already did)
+change and b) whenever something unexpected happens (e.g. a new route type /
+error condition) the software has to be adjusted.
+
+A second RIS is available, writing periodic MRT dumps and continous BGP update
+message MRT dumps. These should be used instead.
+
+## TODO
+
+ * Replace BGP data collection method
+ * Add WHOIS data to visualization
+
+## Licensing
+This software is licensed under the GPLv3 or later.
+

bgpdata/admin.py

@@ -1,3 +1,7 @@
+# This file is part of dnmapper, an AS--level mapping tool
+# Licensed under GNU General Public License v3 or later
+# Written by Sebastian Lohff (seba@someserver.de)
+
 from django.contrib import admin
 from bgpdata.models import ConfigHost, CrawlRun, CrawlLog, AS, BorderRouter, Announcement, Peering, BorderRouterPair
 

bgpdata/api.py

@@ -1,3 +1,7 @@
+# This file is part of dnmapper, an AS--level mapping tool
+# Licensed under GNU General Public License v3 or later
+# Written by Sebastian Lohff (seba@someserver.de)
+
 from tastypie.resources import ModelResource, ALL_WITH_RELATIONS, ALL
 from tastypie import fields
 from bgpdata.models import AS, CrawlRun, Announcement, BorderRouter

bgpdata/models.py

@@ -1,3 +1,7 @@
+# This file is part of dnmapper, an AS--level mapping tool
+# Licensed under GNU General Public License v3 or later
+# Written by Sebastian Lohff (seba@someserver.de)
+
 from django.db import models
 from django.db.models import Q
 

bgpdata/urls.py

@@ -1,3 +1,7 @@
+# This file is part of dnmapper, an AS--level mapping tool
+# Licensed under GNU General Public License v3 or later
+# Written by Sebastian Lohff (seba@someserver.de)
+
 from django.conf.urls import patterns, url, include
 #from django.views.generic import RedirectView
 from api import ASResource, CrawlResource, BorderRouterResource, AnnouncementResource

bgpdata/views.py

@@ -1,3 +1,7 @@
+# This file is part of dnmapper, an AS--level mapping tool
+# Licensed under GNU General Public License v3 or later
+# Written by Sebastian Lohff (seba@someserver.de)
+
 from django.shortcuts import render
 from bgpdata.models import CrawlRun, AS, Peering
 from django.core.paginator import Paginator

bin/checkmk-routing.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
+# This file is part of dnmapper, an AS--level mapping tool
+# Licensed under GNU General Public License v3 or later
+# Written by Sebastian Lohff (seba@someserver.de)
 
 # get state from routing information, targeted are routing protocols
 # currently supporting quagga and bird

bin/crawl.py

@@ -1,4 +1,8 @@
 #!/usr/bin/env python2
+# This file is part of dnmapper, an AS--level mapping tool
+# Licensed under GNU General Public License v3 or later
+# Written by Sebastian Lohff (seba@someserver.de)
+
 from __future__ import print_function
 
 # config

bin/routerparsers.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python
-
+# This file is part of dnmapper, an AS--level mapping tool
+# Licensed under GNU General Public License v3 or later
+# Written by Sebastian Lohff (seba@someserver.de)
 from __future__ import print_function
 
 import re

dnmapper/settings.default.py

@@ -1,3 +1,6 @@
+# This file is part of dnmapper, an AS--level mapping tool
+# Licensed under GNU General Public License v3 or later
+# Written by Sebastian Lohff (seba@someserver.de)
 """
 Django settings for dnmapper project.
 

dnmapper/settings.py

@@ -1,3 +1,6 @@
+# This file is part of dnmapper, an AS--level mapping tool
+# Licensed under GNU General Public License v3 or later
+# Written by Sebastian Lohff (seba@someserver.de)
 """
 Django settings for dnmapper project.
 

dnmapper/urls.py

@@ -1,3 +1,7 @@
+# This file is part of dnmapper, an AS--level mapping tool
+# Licensed under GNU General Public License v3 or later
+# Written by Sebastian Lohff (seba@someserver.de)
+
 from django.conf.urls import patterns, include, url
 from django.contrib import admin
 from django.views.generic import RedirectView

dnmapper/wsgi.py

@@ -1,3 +1,6 @@
+# This file is part of dnmapper, an AS--level mapping tool
+# Licensed under GNU General Public License v3 or later
+# Written by Sebastian Lohff (seba@someserver.de)
 """
 WSGI config for dnmapper project.