Mobile sites: Require specification of whether we think we are mobile

[secnet.git] / README

diff --git a/README b/README
index 3736b89bbf5dfe1b8f81574d098e456709058e4e..7e40edf2024f109df94f4e9134db21927af82017 100644 (file)
--- a/README
+++ b/README
@@ -322,6 +322,12 @@ site: dict argument
   mobile-peer-expiry (integer): For "mobile" peers only, the length
     of time (in seconds) for which we will keep sending to multiple
     address/ports from which we have not seen incoming traffic. [120]
+  local-mobile (bool): if True then other peers have been told we are
+    "mobile".  This should be True iff the peers' site configurations
+    for us have "mobile True" (and if we find a site configuration for
+    ourselves in the config, we insist on this).  The effect is to
+    check that there are no links both ends of which are allegedly
+    mobile (which is not supported, so those links are ignored). [false]
 
 ** transform