From ea9f7e8b20e84d8f874c24180e0f5c18d460a1df Mon Sep 17 00:00:00 2001 From: Baptiste Jonglez Date: Sun, 6 Jun 2021 19:09:09 +0200 Subject: [PATCH] README: Improve installation / configuration doc --- README.mkd | 38 ++++++++++++++++++++++++++++++++++---- 1 file changed, 34 insertions(+), 4 deletions(-) diff --git a/README.mkd b/README.mkd index 9c2f4ff..1318888 100644 --- a/README.mkd +++ b/README.mkd @@ -1,6 +1,9 @@ BIRD-LG ======= +Overview +-------- + This is a looking glass for the Internet Routing Daemon "Bird". Software is split in two parts: @@ -8,7 +11,8 @@ Software is split in two parts: - lgproxy.py: It must be installed and started on all bird nodes. It act as a proxy to make traceroute and bird query on the node. - Access restriction to this web service can be done in file "lgproxy.cfg" (only IP address based restriction for now). + Access restriction to this web service can be done in file "lgproxy.cfg". Two access restriction methods can be configured: + based on source IP address or based on a shared secret. Both methods can be used at the same time. - lg.py: @@ -33,16 +37,42 @@ Software is split in two parts: ``` -bird-lg depends on : +Installation +------------ + +The web service (lg.py) depends on: - python-flask >= 0.8 - python-dnspython - python-pydot - graphviz - whois - - traceroute -Each services can be embedded in any webserver by following regular python-flask configuration. +The proxy running on routers (lgproxy.py) depends on: + + - python-flask >= 0.8 + - traceroute + - ping + +Each service can be embedded in any webserver by following regular python-flask configuration. +It is also possible to run the services directly with python for developping / testing: + + python2 lg.py + python2 lgproxy.py + +Systemd unit files are provided in the `init/` subdirectory. + + +Configuration +------------- + +On your routers, copy `lgproxy.cfg.example` to `lgproxy.cfg` and edit the values. + +On the web host, copy `lg.cfg.example` to `lg.cfg` and edit the values. + + +License +------- Source code is under GPL 3.0, powered by Flask, jQuery and Bootstrap.