minor fixes

Author: a-gave

.gitignore

@@ -1,8 +1,10 @@
+*~
 cache
 dist
 temp
 
 node_modules/
+
 /docs/packages/**
 !/docs/packages/index.md
 

docs/.vitepress/config.mts

@@ -108,14 +108,13 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
           link: '/guide/packages-selection', 
           collapsed: true,
           items: [
-          { text: 'Build customization', link: '/guide/packages-selection' },
           { text: 'Network Profiles', link: '/guide/network-profiles' }
         ] },
         { text: 'Build LibreMesh', 
-          link: '/build',
+          link: '/build/',
           collapsed: true,
           items: [
-            { text: 'Build methods', link: '/build/' },
+            // { text: 'Build methods', link: '/build/' },
             { text: 'ImageBuilder', link: '/build/imagebuilder' },
             { text: 'lime-sdk', link: '/build/lime-sdk' },
             { text: 'Buildroot', link: '/build/buildroot'}
@@ -193,23 +192,26 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
         { text: 'Configuration', link: 'configuration' },
         { text: 'lime-config', link: 'lime-config' },
         { text: 'Flavors', link: 'flavors' },
-        { text: 'Default protocols', items: [
-          { text: 'Batman-adv', link: 'network/protocols/batman-adv'},
-          { text: 'Babeld', link: 'network/protocols/babeld'},
+        { text: 'Default protocols', 
+          collapsed: true,
+          items: [
+          { text: 'Batman-adv', link: 'protocols/batman-adv'},
+          { text: 'Babeld', link: 'protocols/babeld'},
         ]},
         { text: 'lime-files', items: [
-          { text: 'System options', link: 'system' },
-          { text: 'Network options', link: 'network/', items: [
-            { text: 'General options', link: 'network/#general-options'},
+          { text: 'System', link: 'system' },
+          { text: 'Network', link: 'network/', items: [
+            { text: 'General', link: 'network/#general-options'},
             { text: 'DNS servers', link: 'network/#dns-servers'},
             { text: 'Protocols list', link: 'network/protocols-list'},
             { text: 'Protocols options', link: 'network/protocols-options'},
-            { text: 'Interface specific options', link: 'network/interface-specific'},
+            { text: 'Interface specific', link: 'network/interface-specific'},
           ] },
-          { text: 'WiFi options', link: 'wifi', items: [
-            { text: 'General options', link: 'wifi'},
-            { text: 'Band specific options', link: 'wifi/band-specific'},
-            { text: 'Interface specific options', link: 'wifi/interface-specific'},
+          { text: 'WiFi', link: 'wifi/', items: [
+            { text: 'General', link: 'wifi/#general-options'},
+            { text: 'Modes', link: 'wifi/modes'},
+            { text: 'Band specific', link: 'wifi/band-specific'},
+            { text: 'Interface specific', link: 'wifi/interface-specific'},
           ] },
           { text: 'Generic UCI configs', link: 'generic_config' },
           { text: 'Hardware detection', 

docs/getting-started.md

@@ -42,19 +42,18 @@ Refers the the page [`Build LibreMesh`](/build/) for instructions on how to buil
 Install the firmware on your device following the installation method reported in the [wiki of OpenWrt](https://openwrt.org)
 or, if not present, search the instruction in the **`git-commit` message** left from who added the support for that device model. See the [Table of Hardware](https://toh.openwrt.org).
 
-https://openwrt.org/docs/guide-quick-start/factory_installation
-
 ::: tip NOTE
-It is strongly adviced to **install OpenWrt first**:
+If your device runs OEM firmware it is adviced to **install OpenWrt first**:
+:::
+
 1. Download the latest `stable` firmware for your device from the [`OpenWrt Firmware Selector`](https://firmware-selector.openwrt.org).    
-   If your device runs OEM firmware use the `factory` for first time installation.
+   Use the `factory` image for first time installation. See the OpenWrt wiki page [Factory Install: First Time Installation](https://openwrt.org/docs/guide-quick-start/factory_installation):
 2. Check that the OpenWrt device boot and function properly.    
    Beware that OpenWrt by default doesn't turn on the Wi-Fi.    
    Turn it on from `LuCi` from the menu `Network` / `Wireless`.
-3. Upgrade to LibreMesh:
+3. Upgrade to LibreMesh using a `sysupgrade` image:
     - upload the firmware via the web interface `LuCI` from the menu `System` / `Backup / Flash Firmware`.
     - or via ssh using the command `sysupgrade -n firmware.bin`
-:::
 
 
 ## Connecting to the router

docs/guide/packages-selection.md

@@ -1,7 +1,6 @@
 ---
 outline: deep
 ---
-
 <script setup>
 import { data as openwrt } from '/openwrt.data.js'
 </script>
@@ -18,7 +17,8 @@ It is **highly discouraged** to `upgrade` packages. Read the OpenWrt's [`Upgrade
 :::
 
 ::: warning ath9k warning
-Routers with Atheros radios and the `ath9k` driver have a known bug that cause them to become deaf, if you are using an OpenWrt older than 24.10.6 be sure to include the libremesh package `wifi-unstuck-wa` 
+Routers with Atheros radios and the `ath9k` driver have a known bug that cause them to become deaf, 
+if you are using an OpenWrt older than 24.10.6 be sure to include the libremesh package `wifi-unstuck-wa` 
 :::
 
 ::: warning ath10k warning
@@ -69,26 +69,32 @@ Additionally these packages could be `excluded` in the firmware build:
 
 :::
 
-The same formatted as list
+The same list to use when building with Buildroot.
 ::: code-group
 
 
 ``` [{{ openwrt.stable_version }}]
--dnsmasq
--odhcpd-ipv6only
--apk-mbedtls
--ca-bundle
--ppp
--ppp-mod-pppoe
+cat << EOF >> .config
+CONFIG_PACKAGE_dnsmasq=m
+CONFIG_PACKAGE_odhcpd-ipv6only=m
+CONFIG_PACKAGE_apk-mbedtls=m
+CONFIG_PACKAGE_ca-bundle=m
+CONFIG_PACKAGE_ppp=m
+CONFIG_PACKAGE_ppp-mod-pppoe=m
+EOF
+make defconfig
 ```
 
 ``` [{{ openwrt.oldstable_version }}]
--dnsmasq
--odhcpd-ipv6only
--opkg
--ca-bundle
--ppp
--ppp-mod-pppoe
+cat << EOF >> .config
+CONFIG_PACKAGE_dnsmasq=m
+CONFIG_PACKAGE_odhcpd-ipv6only=m
+CONFIG_PACKAGE_opkg=m
+CONFIG_PACKAGE_ca-bundle=m
+CONFIG_PACKAGE_ppp=m
+CONFIG_PACKAGE_ppp-mod-pppoe=m
+EOF
+make defconfig
 ```
 
 :::

docs/guide/upgrade.md

@@ -8,10 +8,26 @@ In **production environments with multiple LibreMesh nodes** deployed, it is adv
 :::
 
 Refers to the OpenWrt Wiki for details about the upgrade process:
+- [Sysupgrade](https://openwrt.org/docs/techref/sysupgrade)
 - [Upgrading OpenWrt firmware using LuCI and CLI](https://openwrt.org/docs/guide-user/installation/generic.sysupgrade)
 - [Preserving OpenWrt settings during firmware upgrade](https://openwrt.org/docs/guide-quick-start/admingui_sysupgrade_keepsettings)
 
 
+## Sysupgrade
+The default OpenWrt command `sysupgrade` preserve:
+- files defined in `/lib/upgrade/keep.d`
+- the list of `conffiles` (configuration files defined by certain packages) that has been changed:
+  - See the whole list for `apk` with `cat /lib/apk/packages/*.conffiles`
+  - See the whole list for `opkg` with `cat /usr/lib/opkg/info/*.conffiles`
+
+Initial files are preserved in `/rom/` and changed files are created at `/overlay/upper/`.
+
+```
+apk add diffutils
+diff /overlay/upper/etc/config/babeld /rom/etc/config/babeld
+```
+
+
 ## Examples
 
 ### Upgrade to a new major OpenWrt release

docs/reference/configuration.md

@@ -24,7 +24,6 @@ The options contained in these files are merged and overwritten from the lowest
 
 ::: tip Interface specific options
 Interface specific options have to be included in `lime-node` or `lime-<MAC>`.
-If in `lime-community` they'll cause unpredictable behaviour.
 :::
 
 ### Parametrizable options

docs/reference/lime-config.md

@@ -6,18 +6,22 @@ outline: deep
 The command `lime-config` configures LibreMesh on top of OpenWrt.
 
 ## lime-files
-Merge them from the low level `lime-defaults` to top level `lime-node` to produce the complete configuration in `lime-autogen`
+These files are merged from the low level `lime-defaults` to top level `lime-node` to produce the complete configuration in `lime-autogen`.
 
 ## Modules
-Modules are configured in this order `hardware_detection`, `wireless`, `network`, `firewall`, `system`, `generic_config`
+Modules are configured in this order `hardware_detection`, `wireless`, `network`, `firewall`, `system`, `generic_config`.
 
 ### hardware_detection
 Loads all packages starting with `lime-hwd-*`    
 `lime-hwd-openwrt-wan` configures the OpenWrt wan port as WAN. If disabled, or the package is not installed, the wan port is configured as LAN.
 
 ### wireless
 Scan the OpenWrt device to find existing radios.   
-Produce the UCI configuration for each radio, loading configs from `lime-autogen` in the order: `wifi`, `2ghz`|`5ghz`, specific `radioN`
+Produce the UCI configuration for each radio, loading configs from `lime-autogen` in the order: 
+- `config lime 'wifi'` (wifi general options)
+- `config lime '5ghz'` (band specific options)
+- `config lime '2ghz'` (band specific options)
+- `config radioN` (radio specific options)
 
 ### network
 
@@ -103,28 +107,23 @@ config zone
 Set `hostname` and `root_password`
 
 ### generic_config
-Apply the sections `generic_uci_config`, `copy_asset` and `run_asset`
+Reads and execute the sections `generic_uci_config`, `copy_asset` and `run_asset`. 
+Apply custom UCI configuration or copy/execute shell scripts.
+See the page [Generic Config](generic_config) for detailed options.
 
-#### generic_uci_config
+
+## Commit changes
+Changes are committed by the command `lime-config` and written in `/etc/config/` files.  
+::: tip  
+Be sure to do not loose the connection to your device after the configuration.    
+To apply the changes the **safest way** is to perform a `reboot` of the device.    
+:::
+
+### lime-apply
+On most cases one can skip the reboot running the command `lime-apply` which calls the OpenWrt `reload_config`.  
+Depending on the changed configurations a full restart of some services may be required, like `wireless`, `network` and `firewall`.    
 ```
-config generic_uci_config 'uhttpd_https'
-	list uci_set 'uhttpd.main.redirect_https=0'
+lime-config; lime-apply; wifi; \
+/etc/init.d/network restart; \
+/etc/init.d/firewall restart
 ```
-By default `uhttpd` is instructed to avoid force redirect from `http` to `https`
-
-#### copy_asset
---! copy_asset copy an file from the assets directory into a specified path.
---! The node asset directories are /etc/lime-assets/node and /etc/lime-assets/community.
---! The community directory should contain the same files in all the community nodes.
---!
---! config copy_asset collectd
---!    option asset 'community/collectd.conf' # or 'node/collectd.conf' or 'community/mynode_collectd.conf'
---!    option dst '/etc/collectd.conf'
---!
-
-#### run_asset
---! Executes a file from the assets directory scheme explained in copy_asset.
---!
---! config run_asset dropbear
---!     option asset 'community/dropbear.sh'
---!     option when 'ATFIRSTBOOT' # ATFIRSTBOOT, ATCONFIG

docs/reference/network/index.md

@@ -3,9 +3,44 @@ outline: deep
 ---
 
 # Network options
+Configuration for each network device is calculated from:
+- the **general options** in `config lime network`, 
+- an (optional) **interface specific section** relative to that specific network device.
+
+## Default values
+Default values as per `/etc/config/lime-defaults`
+```
+config lime network
+	option primary_interface 'eth0'
+	option main_ipv4_address '10.%N1.0.0/16'
+	option anygw_dhcp_start '2'
+	option anygw_dhcp_limit '0'
+	option main_ipv6_address 'fd%N1:%N2%N3:%N4%N5::/64'
+	list protocols ieee80211s
+	list protocols lan
+	list protocols anygw
+	list protocols batadv:%N1
+	list protocols olsr:14
+	list protocols olsr6:15
+	list protocols olsr2:16
+	list protocols babeld:17
+	list protocols bmx7:18
+	list resolvers 4.2.2.2   # b.resolvers.Level3.net
+	list resolvers 141.1.1.1 # cns1.cw.net
+	list resolvers 2001:470:20::2 # ordns.he.net
+	option bmx7_mtu '1500'
+	option bmx7_publish_ownip false
+	option bmx7_over_batman false
+	option bmx7_pref_gw none
+	option bmx7_wifi_rate_max 'auto'
+	option bmx7_enable_pki false
+	option batadv_orig_interval '2000'
+	option batadv_routing_algo 'BATMAN_IV'
+	option anygw_mac "aa:aa:aa:%N1:%N2:aa"
+	option use_odhcpd false
+```
 
 ## General options
-The default values as per `lime-defaults`
 ```
 config lime 'network'
 	option primary_interface 'eth0'
@@ -17,13 +52,15 @@ config lime 'network'
 - Type: `string`
 - Default: `eth0`
 
-
 ```
 config lime network
     option primary_interface 'eth0'
 ```
 
-The mac address of this device will be used in different places
+The mac address of this device will be used in different places.    
+An partial list includes:
+- Options parametrized with `%Mn`
+- Batman-adv soft interfaces use the last 3 bytes from main interface bat0 which is equal to the mac of `primary_interface`
 
 ### main_ipv4_address
 - Type: `<static>|<parametrized>|<network-address>`

docs/reference/network/interface-specific.md

@@ -19,10 +19,25 @@ Available protocols: `apbb, batadv, babeld, bgp, bmx7, client, lan, manual, olsr
 If you use the protocol `manual` do not specify other protocols, may result in an unpredictable behavior/configuration (likely you loose connection to the node)
 :::
 
-## WAN port
-Configure an network ethernet port as WAN using the protocol `wan` or `static`.
+## Examples
+### WAN port
+Configure a network ethernet port as WAN using the protocol `wan` or `static`.
 
-### wan (DHCP)
+::: tip
+LibreMesh in the default flavor preserve the default openwrt WAN port.    
+This interface gets created by `lime-hwd-openwrt-wan` package in case an ethernet WAN port is detected.    
+**Disable the default interface** `lm_hwd_openwrt_wan` if you intend to configure a different port as wan.  
+:::
+
+#### Disable default
+```
+config net lm_hwd_openwrt_wan
+    option autogenerated 'false'
+```
+- `autogenerated 'false'` - Specify that the configuration of the WAN ethernet port has been manually edited.
+
+
+#### wan (DHCP)
 Use `wan` protocol to get Internet connectivity via DHCP
 ```
 config net port1_wan
@@ -31,7 +46,7 @@ config net port1_wan
 
 ```
 
-### static (ipv4)
+#### static (ipv4)
 Use `static` protocols and specify the router 'IPv4/subnet' and the gateway IPv4.
 ```
 config net port1_wan
@@ -41,7 +56,7 @@ config net port1_wan
   option static_gateway_ipv4 '192.168.1.1'
 ```
 
-### static (ipv6)
+#### static (ipv6)
 Use `static` protocols and specify the router 'IPv6/subnet' and the gateway IPv6.
 ```
 config net port1_wan
@@ -51,15 +66,15 @@ config net port1_wan
   option static_gateway_ipv6 'fe80::1'
 ```
 
-## LAN port
+### LAN port
 Configure `lan1` for users to connect to, not for connection to other nodes.
 ```
 config net port1
     option linux_name 'lan1'
     list protocols 'lan'
 ```
 
-## Mesh only port
+### Mesh only port
 The protocol `batadv:%N1` needs to be specified if the other node is in the same mesh cloud i.e. same `ap_ssid`.
 ```
 config net port1