README/COPYING Update

COPYING

@@ -0,0 +1,17 @@
+ bird-lg
+ =======
+
+ Copyright (c) 2006 Mehdi Abaakouk
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA

README

@@ -1,20 +0,0 @@
-
-bird-lg depend on :
- - python-flask  >= 0.8
- - python-dnspython
-
-
-On all bird nodes:
-	fill the config file lg-proxy.cfg by list all ips that can acces to the proxy
-	and start "python lg-proxy.py"
-
-
-On frontend:
-	fill config file lg.cfg by list all bird nodes
-	and start "python lg.py"
-
-
-Each service can by embeded in any webserver by follow regular python-flask configuration
-
-
-Only tested with bird 1.2.5

README.mkd

@@ -0,0 +1,42 @@
+
+BIRD-LG
+=======
+
+this is a looking glass for the Internet Routing Daemon "Bird"
+
+
+software is splited onto two parts:
+ - lg-proxy.py: 
+   It must be install and started on all bird node. It act as a proxy to make traceroute and bird query on the node
+   Also the access restriction to this web service can be done is file "lg-proxy.cfg" (only ip based restriction for now)
+
+ - lg.py:
+   This is the frontend, a web based UI that request information to all lg-proxy.py nodes
+   The domain and the list of all bird node can be done
+
+
+
+                                         ***************
+                                    +--> * lg-proxy.py *
+                                    |    ***************
+                                    |  
+********       *******************  |    ***************
+* USER * ----> * webserver/lg.py *--+--> * lg-proxy.py *
+********       *******************  |    ***************
+                                    |  
+                                    |    ***************
+                                    +--> * lg-proxy.py *
+                                         ***************
+
+
+bird-lg depend on :
+ - python-flask  >= 0.8
+ - python-dnspython
+
+Each service can by embeded in any webserver by follow regular python-flask configuration
+
+Only tested with bird 1.2.5
+
+source code under GPL 3.0, powered by Flask, jQuery and Bootstrap
+
+Copyright (c) 2012 Mehdi Abaakouk <sileht@sileht.net>