Browse Source

First step to add some documentation

Add ReadMe.md for:
- ffho-alfred-watchdog
- ffho-autoupdater
- ffho-autoupdater-wifi-fallback
- ffho-autoupdater-wifi-fallback-legacy
- ffho-banner
- ffho-config-mode-geo-location
- ffho-config-mode-mesh-vpn
- ffho-debug
- ffho-geo-location-altitude-delete
- ffho-respondd-config
- ffho-status-page
- ffho-txpower-fix
- ffho-wifi-blackout-workaround
- ffho-wifi-mesh-macfilter

Add incomplete ReadMe.md for:
- ffho-ebtables-net-rules
- ffho-node-tuning

Update:
- ffho-txpower-fix/Makefile
- ffho-wifi-blackout-workaround/files/etc/hotplug.d/iface/99-ath9k_disable_ani
Karsten Böddeker 8 years ago
parent
commit
fd8adabc75

+ 4 - 0
ffho/ffho-alfred-watchdog/ReadMe.md

@@ -0,0 +1,4 @@
+ffho-alfred-watchdog
+====================
+
+*OBSOLETE*

+ 4 - 0
ffho/ffho-autoupdater-wifi-fallback-legacy/ReadMe.md

@@ -0,0 +1,4 @@
+ffho-autoupdater-wifi-fallback-legacy
+=====================================
+
+Only needed to upgrade the configuration from an old version to the current on.

+ 8 - 0
ffho/ffho-autoupdater-wifi-fallback/ReadMe.md

@@ -0,0 +1,8 @@
+ffho-autoupdater-wifi-fallback
+==============================
+
+If a node has no connection to the mesh, neither via wlan-mesh nor via
+mesh-vpn, it ist not possible to update this node via ``autoupdater``. There for
+the *wifi-fallback* was developed, to check whether the node is part of a fully
+working mesh or not. Else the node connects to a visible "Freifunknetz" and
+tries downloads an update as wlan-client via executing ``autoupdater -f``.

+ 4 - 0
ffho/ffho-autoupdater/ReadMe.md

@@ -0,0 +1,4 @@
+ffho-autoupdater
+================
+
+This is a customized version of ``gluon-autoupdater``.

+ 4 - 0
ffho/ffho-banner/ReadMe.md

@@ -0,0 +1,4 @@
+ffho-banner
+===========
+
+Banner file replacement for customization of login screen.

+ 14 - 0
ffho/ffho-config-mode-geo-location/ReadMe.md

@@ -0,0 +1,14 @@
+ffho-config-mode-geo-location
+=============================
+
+This package enables the user to set latitude, longitude and altitude of their
+node within config mode. As the usage of the altitude is not well defined the
+corresponding field can be disabled.
+
+site.conf
+---------
+
+config_mode.geo_location.show_altitude : optional
+    - ``true`` enables the altitude field
+    - ``false`` disables the altitude field if altitude has not yet been set
+    - defaults to ``true``

+ 5 - 0
ffho/ffho-config-mode-mesh-vpn/ReadMe.md

@@ -0,0 +1,5 @@
+ffho-config-mode-mesh-vpn
+=========================
+
+Costomization of ``gluon-config-mode-mesh-vpn`` to use the contactinformation
+within the reboot page.

+ 16 - 0
ffho/ffho-debug/ReadMe.md

@@ -0,0 +1,16 @@
+ffho-debug
+==========
+
+Debug scripts for Freifunk Hochstift.
+
+site.conf
+---------
+
+debugserver.host
+    - list of possible debugserver
+
+debugserver.port
+    - destination port for debug reports
+
+debugserver.liveport
+    - destination port for ``ffho-debug-live``

+ 15 - 0
ffho/ffho-ebtables-net-rules/ReadMe.md

@@ -0,0 +1,15 @@
+ffho-ebtables-net-rules
+=======================
+
+site.conf
+---------
+
+prefix4
+    - IPv4 prefix
+
+prefix6
+    - IPv6 prefix
+
+additional_prefix6 : optional
+    - list of additional IPv6 prefixes
+

+ 5 - 0
ffho/ffho-geo-location-altitude-delete/ReadMe.md

@@ -0,0 +1,5 @@
+ffho-geo-location-altitude-delete
+=================================
+
+As the usage of the altitude is not well defined this package provides an
+upgrade script to delete the altitude value.

+ 3 - 0
ffho/ffho-node-tuning/ReadMe.md

@@ -0,0 +1,3 @@
+ffho-node-tuning
+================
+

+ 11 - 0
ffho/ffho-respondd-config/ReadMe.md

@@ -0,0 +1,11 @@
+ffho-respondd-config
+====================
+
+Customization of respondd data. Actually it transmitts the site_name in addition
+to other values.
+
+site.conf
+---------
+
+site_name
+    - The name of your community

+ 4 - 0
ffho/ffho-status-page/ReadMe.md

@@ -0,0 +1,4 @@
+ffho-status-page
+================
+
+This is a customized version of the *old* ``gluon-status-page``.

+ 1 - 1
ffho/ffho-txpower-fix/Makefile

@@ -20,7 +20,7 @@ define Package/ffho-txpower-fix/description
 	With chaoscalmer, wifi nodes seemed to be locked to less txpower than they could do.
 	First suggestions are, that this is a mistake in the upstream OpenWrt-Code. Even the
 	bugtrackers of OpenWrt are full of this. 
-	The idea of this workaround is, to check if the txpower could be increased iff it isn't
+	The idea of this workaround is, to check if the txpower could be increased if it isn't
 	already set to a special value. Unfortunately this can only be done by setting the 
 	country code to 00.
 endef

+ 10 - 0
ffho/ffho-txpower-fix/ReadMe.md

@@ -0,0 +1,10 @@
+ffho-txpower-fix
+================
+
+With chaoscalmer, wifi nodes seemed to be locked to less txpower than they could
+do. First suggestions are, that this is a mistake in the upstream OpenWrt-Code.
+Even the bugtrackers of OpenWrt are full of this.
+
+The idea of this workaround is, to check if the txpower could be increased if
+it isn't already set to a special value. Unfortunately this can only be done by
+changing the country code.

+ 6 - 0
ffho/ffho-wifi-blackout-workaround/ReadMe.md

@@ -0,0 +1,6 @@
+ffho-wifi-blackout-workaround
+=============================
+
+In order to avoid further WiFi-Blackouts that *might* be caused by a buggy ANI
+feature in the ath9k kernel module, we disable ANI until it got fixed in
+OpenWRT completely.

+ 2 - 2
ffho/ffho-wifi-blackout-workaround/files/etc/hotplug.d/iface/99-ath9k_disable_ani

@@ -3,8 +3,8 @@
 # "ANI-thing is better than no WiFi"-Workaround
 #
 # In order to avoid further WiFi-Blackouts that *might* be caused by a buggy
-# ANI feature in the ath9k kernel module, we disable ANI for nodes using the
-# "stable" firmware branch until it got fixed in OpenWRT completely.
+# ANI feature in the ath9k kernel module, we disable ANI until it got fixed in
+# OpenWRT completely.
 
 # Don't need to do anything, unless the script gets triggered by an "ifup"
 # event.

+ 9 - 0
ffho/ffho-wifi-mesh-macfilter/ReadMe.md

@@ -0,0 +1,9 @@
+ffho-wifi-mesh-macfilter
+========================
+
+Setting plink_action [block|open], when 802.11s mesh-interface comes up. Define
+filterpolicy in uci wireless.<wifi-iface>.macfilter=[disable|deny|allow]. Deny
+sets ``iw dev <device> station set <mac> plink_action block`` and allow sets
+``iw dev <device> mesh_param mesh_auto_open_plink=0`` and ``iw dev <device>
+station set <mac> plink_action open``. List MAC adresses (divided by spaces) in
+uci wireless.<wifi-iface>.maclist.