[docs] Added documentation

openwisp · Oct 11, 2023 · 73e5783 · 73e5783
1 parent 88bc9d8
commit 73e5783
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/source/images/mac-address-roaming.png b/docs/source/images/mac-address-roaming.png
diff --git a/docs/source/user/settings.rst b/docs/source/user/settings.rst
@@ -603,6 +603,31 @@ via the organization radius settings section of the admin interface.
 
 .. _openwisp_radius_needs_identity_verification:
 
+``OPENWISP_RADIUS_MAC_ADDR_ROAMING_ENABLED``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Default**: ``False``
+
+Indicates whether MAC address roaming is supported.
+When this setting is enabled (i.e. ``True``),
+MAC address roaming is enabled for all organizations.
+
+**This setting can be overridden in individual organizations
+via the admin interface**, by going to *Organizations*
+then edit a specific organization and scroll down to
+*"Organization RADIUS settings"*, as shown in the screenshot below.
+
+.. image:: /images/mac-address-roaming.png
+   :alt: Organization MAC Address Roaming settings
+
+.. note::
+
+    We recommend using the override via the admin interface only when there
+    are special organizations which need a different configuration, otherwise,
+    if all the organization use the same configuration, we recommend
+    changing the global setting.
+
+
 ``OPENWISP_RADIUS_NEEDS_IDENTITY_VERIFICATION``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~