From b7ac32efbc890c5b920bd542dca5c0e2163d5280 Mon Sep 17 00:00:00 2001 From: David Bauer Date: Tue, 3 Mar 2020 20:15:28 +0100 Subject: [PATCH] docs: include OWE documentation --- docs/site-example/site.conf | 8 ++++++-- docs/user/site.rst | 13 +++++++++++-- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/site-example/site.conf b/docs/site-example/site.conf index b662b011..1b41c99d 100644 --- a/docs/site-example/site.conf +++ b/docs/site-example/site.conf @@ -42,10 +42,14 @@ -- Wireless channel. channel = 1, - -- ESSID used for client network. + -- ESSIDs used for client network. ap = { - ssid = 'alpha-centauri.freifunk.net', + -- ssid = 'alpha-centauri.freifunk.net', (optional - SSID for open client network) -- disabled = true, -- (optional) + + -- Configuration for a non-backward compatible OWE network below. + -- owe_ssid = 'owe.alpha-centauri.freifunk.net', -- (optional - SSID for OWE client network) + -- owe_transition_mode = true, -- (optional - enables transition-mode - requires ssid as well as owe_ssid) }, mesh = { diff --git a/docs/user/site.rst b/docs/user/site.rst index 1094c782..2d68ed92 100644 --- a/docs/user/site.rst +++ b/docs/user/site.rst @@ -130,8 +130,15 @@ wifi24 \: optional This will only affect new installations. Upgrades will not change the disabled state. - ``ap`` requires a single parameter, a string, named ``ssid`` which sets the - interface's ESSID. This is the WiFi the clients connect to. + ``ap`` holds the client network configuration. + To create an unencrypted client network, a string named ``ssid`` which sets the + interface's ESSID is required. This is the wireless network clients connect to. + For an OWE secured network, the ``owe_ssid`` string has to be set. It sets the + SSID for the opportunistically encrypted wireless network, to which compatible + clients can connect to. + To utilize the OWE transition mode, ``owe_transition_mode`` has to be set to true. + Note that for the transition mode to work, both ``ssid`` as well as ``owe_ssid`` + have to be enabled. ``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 @@ -147,6 +154,8 @@ wifi24 \: optional channel = 11, ap = { ssid = 'alpha-centauri.freifunk.net', + owe_ssid = 'owe.alpha-centauri.freifunk.net', + owe_transition_mode = true, }, mesh = { id = 'ueH3uXjdp',