diff --git a/docs/features/status-page.png b/docs/features/status-page.png new file mode 100644 index 0000000000000000000000000000000000000000..604651b25fbee1118a1803639ff33d467d7afab3 Binary files /dev/null and b/docs/features/status-page.png differ diff --git a/docs/features/status-page.rst b/docs/features/status-page.rst new file mode 100644 index 0000000000000000000000000000000000000000..b38a1506a50a6f14cb6566c20bc45a12a749066c --- /dev/null +++ b/docs/features/status-page.rst @@ -0,0 +1,30 @@ +Status-Page +=========== + +When the feature ``gluon-status-page`` is enabled, Gluon nodes run a HTTP server with status information on all IP addresses of ``br-client``. +This makes it possible to check information of the node in realtime. + +If the mesh protocol ``gluon-mesh-batman-adv`` is installed too, the package ``gluon-status-page-mesh-batman-adv`` is added too according to the :ref:`user-site-feature-flags` + +.. _status-page-example-picture: + +Example Picture +--------------- + +The left side of the status page contains Overview information. +In the middle, current monitoring information abut the system, number of clients, radios, amount of traffic and connected mesh-vpn if any are shown. +The right side of the Status-Page contains information about Neighbours to this node through :doc:`wired-mesh` as well as wireless mesh. + +.. image:: status-page.png + +Mesh Graphs +----------- + +When wireless mesh is enabled, the mesh interfaces show realtime Graphs about the received signal strength (RSSI) in dBm. + +Neighbours +---------- + +The list of neighbours at first shows the mac-address of the neighbour it sees. +The status-page sends a second request to ``http://[ipv6]/cgi-bin/dyn/neighbours-nodeinfo?mesh-vpn`` which triggers the lookup of neighbour information on the node itself. +Through this, the actual nodenames of the neighbours are shown on the status-page as can be seen in the :ref:`status-page-example-picture`. diff --git a/docs/index.rst b/docs/index.rst index 1d0774e2fcb30da7e5231e4a9775a9c762455b84..6fb95706d22d8cba36abd6f4c61e05cf6c2407d0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,6 +32,7 @@ Several Freifunk communities in Germany use Gluon as the foundation of their Fre features/authorized-keys features/roles features/vpn + features/status-page .. toctree:: :caption: Developer Documentation