Browse Source

Readme + GPLv3 licensing

Sebastian Lohff 2 years ago
parent
commit
4d24a285f6

+ 24
- 0
README.md View File

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

+ 4
- 0
bgpdata/admin.py View File

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

+ 4
- 0
bgpdata/api.py View File

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

+ 4
- 0
bgpdata/models.py View File

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

+ 4
- 0
bgpdata/urls.py View File

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

+ 4
- 0
bgpdata/views.py View File

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

+ 3
- 0
bin/checkmk-routing.sh View File

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

+ 4
- 0
bin/crawl.py View File

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

+ 3
- 1
bin/routerparsers.py View File

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

+ 3
- 0
dnmapper/settings.default.py View File

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

+ 3
- 0
dnmapper/settings.py View File

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

+ 4
- 0
dnmapper/urls.py View File

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

+ 3
- 0
dnmapper/wsgi.py View File

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

Loading…
Cancel
Save