diff --git a/docs/package/gluon-config-mode-contact-info.rst b/docs/package/gluon-config-mode-contact-info.rst index 6072aa5a..dc62dc56 100644 --- a/docs/package/gluon-config-mode-contact-info.rst +++ b/docs/package/gluon-config-mode-contact-info.rst @@ -1,16 +1,17 @@ gluon-config-mode-contact-info ============================== -This package allows the user to provide contact information within config mode to be -distributed in the mesh. You can define whether the owner contact field is -obligatory or not in your site.conf. +This package allows the user to provide contact information within config mode +to be distributed in the mesh. You can define whether the owner contact field is +obligatory or not in your ``site.conf``. site.conf --------- -config_mode.owner.obligatory \: optional (defaults to false) - If ``obligatory`` is set to ``true``, the contact info field must be supplied - and may not be left empty. +config_mode.owner.obligatory \: optional + - ``true`` the contact info field must be supplied and may not be left empty. + - ``false`` the contact info field may be left empty. + - defaults to ``false`` Example:: diff --git a/docs/package/gluon-config-mode-geo-location.rst b/docs/package/gluon-config-mode-geo-location.rst index 83ca238b..4f813e9a 100644 --- a/docs/package/gluon-config-mode-geo-location.rst +++ b/docs/package/gluon-config-mode-geo-location.rst @@ -3,7 +3,7 @@ gluon-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. +corresponding field can be disabled in your ``site.conf``. site.conf --------- @@ -12,3 +12,11 @@ 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`` + +Example:: + + config_mode = { + geo_location = { + show_altitude = true, + } + } diff --git a/docs/package/gluon-ebtables-source-filter.rst b/docs/package/gluon-ebtables-source-filter.rst index 99ed2137..1bbb2e07 100644 --- a/docs/package/gluon-ebtables-source-filter.rst +++ b/docs/package/gluon-ebtables-source-filter.rst @@ -6,8 +6,8 @@ ruleset to prevent unreasonable traffic entering the network via the nodes. Unreasonable means traffic entering the mesh via a node which source IP does not belong to the configured IP space. -One may first check if there is a certain proportion of unreasonable traffic, -before adding this package to the firmware image. Additional one should not +You may first check if there is a certain proportion of unreasonable traffic, +before adding this package to the firmware image. Furthermore, you should not use this package if some kind of gateway or upstream network is provided by a device connected to the client port. @@ -27,4 +27,7 @@ Example:: prefix4 = '198.51.100.0/21', prefix6 = '2001:db8:8::/64', - extra_prefixes6 = { '2001:db8:9::/64', '2001:db8:100::/60' }, + extra_prefixes6 = { + '2001:db8:9::/64', + '2001:db8:100::/60', + }, diff --git a/docs/package/gluon-web-admin.rst b/docs/package/gluon-web-admin.rst index 114f8530..efdab02f 100644 --- a/docs/package/gluon-web-admin.rst +++ b/docs/package/gluon-web-admin.rst @@ -9,15 +9,17 @@ password length must be. site.conf --------- -config_mode.remote_login.show_password_form \: optional (defaults to ``false``) - If ``show_password_form`` is set to ``true``, the password section in - config mode is shown. +config_mode.remote_login.show_password_form \: optional + - ``true`` the password section in config mode is shown + - ``false`` the password section in config mode is hidden + - defaults to ``false`` + +config_mode.remote_login.min_password_length \: optional + - sets the minimum allowed password length. Set this to ``1`` to disable the + length check. + - defaults to ``12`` -config_mode.remote_login.min_password_length \: optional (defaults to ``12``) - This sets the minimum allowed password length. Set this to ``1`` to - disable the length check. - -If you want to enable the password login you can use this example:: +Example:: config_mode = { remote_login = { diff --git a/docs/site-example/site.conf b/docs/site-example/site.conf index 923ff57e..3d317cbf 100644 --- a/docs/site-example/site.conf +++ b/docs/site-example/site.conf @@ -15,8 +15,8 @@ -- Shorthand of the community. site_code = 'ffxx', - -- 32 bytes of random data, encoded in hexacimal - -- Must be the same of all nodes in one mesh domain + -- 32 bytes of random data, encoded in hexadecimal + -- Must be the same for all nodes in one mesh domain -- Can be generated using: echo $(hexdump -v -n 32 -e '1/1 "%02x"'