Browse Source

docs: site-example with cryptic SSID for mesh (#1125)

The SSID for the mesh network should be cryptic, otherwise some users will try to connect to that network and have a bad user experience.
Ruben Barkow 6 years ago
parent
commit
1d2f3be71d
2 changed files with 9 additions and 5 deletions
  1. 3 2
      docs/site-example/site.conf
  2. 6 3
      docs/user/site.rst

+ 3 - 2
docs/site-example/site.conf

@@ -53,7 +53,7 @@
 
     mesh = {
       -- Adjust these values!
-      id = 'ffxx-mesh',
+      id = 'ueH3uXjdp', -- usually you don't want users to connect to this mesh-SSID, so use a cryptic id that no one will accidentally mistake for the client WiFi
       mcast_rate = 12000,
       -- disabled = true, (optional)
     },
@@ -68,7 +68,8 @@
       ssid = 'alpha-centauri.freifunk.net',
     },
     mesh = {
-      id = 'ffxx-mesh',
+      -- Adjust these values!
+      id = 'ueH3uXjdp',
       mcast_rate = 12000,
     },
   },

+ 6 - 3
docs/user/site.rst

@@ -111,9 +111,12 @@ wifi24 \: optional
     The example below disables 802.11b rates.
 
     ``ap`` requires a single parameter, a string, named ``ssid`` which sets the
-    interface's ESSID.
+    interface's ESSID. This is the WiFi the clients connect to.
 
-    ``mesh`` requires a single parameter, a string, named ``id`` which sets the mesh id.
+    ``mesh`` requires a single parameter, a string, named ``id`` which sets the
+    mesh id, also visible as an open WiFi in some network managers. Usually you 
+    don't want users to connect to this mesh-SSID, so use a cryptic id that no
+    one will accidentally mistake for the client WiFi.
 
     ``ibss`` requires two parametersr: ``ssid`` (a string) and ``bssid`` (a MAC).
     An optional parameter ``vlan`` (integer) is supported.
@@ -131,7 +134,7 @@ wifi24 \: optional
            ssid = 'alpha-centauri.freifunk.net',
          },
          mesh = {
-           id = 'alpha-centauri-mesh',
+           id = 'ueH3uXjdp',
            mcast_rate = 12000,
          },
          ibss = {