improve buildroot, restore kernel_vermagic

Author: a-gave

.gitignore

@@ -17,5 +17,6 @@ node_modules/
 
 /docs/build/lime-sdk.md
 
-!/docs/development/hacking/kernel_vermagic.md
-/docs/development/**
+/docs/development/*
+!/docs/development/hacking/
+

docs/build/buildroot.md

@@ -4,6 +4,20 @@ aside: false
 
 <script setup>
 import { data as openwrt } from '/openwrt.data.js'
+
+let arch = 'mips_24kc'
+let target ='ath79-generic'
+let _target =target.replace('-','/')
+
+const build = {
+    arch: arch,
+    target: target,
+    file_host: "https://downloads.openwrt.org",
+    download_file: "imagebuilder-.*x86_64.tar.[xz|zst]",
+    profile: "librerouter_librerouter-v1"
+}
+
+
 </script>
 
 # Buildroot
@@ -22,24 +36,27 @@ gcc-multilib g++-multilib gettext git libncurses5-dev libssl-dev \
 python3-setuptools rsync swig unzip zlib1g-dev file wget
 ```
 
-## Clone the OpenWrt source code
+## Download
+
+### Clone the OpenWrt source code
 Refers to the OpenWrt wiki [Build System Usage](https://openwrt.org/docs/guide-developer/toolchain/use-buildsystem).    
 Run all the above commands as normal user (do not use root).
 
 ::: code-group
 
-``` sh-vue [{{ openwrt.stable_version }}]
+```sh-vue [{{ openwrt.stable_version }}]
 git clone -b v{{ openwrt.stable_version }} --single-branch https://github.com/openwrt/openwrt
 cd openwrt
 ```
 
-``` sh-vue [{{ openwrt.oldstable_version }}]
+```sh-vue [{{ openwrt.oldstable_version }}]
 git clone -b v{{ openwrt.oldstable_version }} --single-branch https://github.com/openwrt/openwrt
 cd openwrt
 ```
 
 :::
 
+### Add the LibreMesh feeds
 Copy the defalt OpenWrt repositories file, and add the LibreMesh repositories
 
 ::: tip
@@ -49,15 +66,15 @@ Use `2024.1` to build the latest LibreMesh release (compatible with openwrt-24.1
 
 ::: code-group
 
-``` sh [master]
+```sh [master]
 cp feeds.conf.default feeds.conf
 cat << EOF >> feeds.conf
 src-git libremesh https://github.com/libremesh/lime-packages.git;master
 src-git profiles https://github.com/libremesh/network-profiles.git
 EOF
 ```
 
-``` sh [2024.1]
+```sh [2024.1]
 cp feeds.conf.default feeds.conf
 cat << EOF >> feeds.conf
 src-git libremesh https://github.com/libremesh/lime-packages.git;v2024.1
@@ -68,115 +85,205 @@ EOF
 :::
 
 
-### Update the packages from the feeds
-``` sh
+### Download and install packages from the feeds
+```sh
 scripts/feeds update -a
 scripts/feeds install -a
 ```
 
 
-### Run the configuration menu
+## Configure 
+
+### Using menuconfig
 ```
 make menuconfig
 ```
 
+![menuconfig1](/buildroot-menuconfig0.webp)
 
+Check out the `target`, `subtarget` and `profile` of your router on [OpenWrt Table of Hardware](https://toh.openwrt.org).
 
+Select then:
+- `Target System` - default `Mediatek ARM`
+- `Subtarget` - default `Filogic`
+- `Target Profile` - default`OpenWrt One`
 
-Check out the +target+ (e.g. +ATH79+), +subtarget+ (e.g. +generic+) and +profile+ (e.g. +tl-wdr3600-v1+) of your router on [OpenWrt table of hardware](https://openwrt.org/toh/start).
+#### Packages selection
 
-Select the _Target System_, _Subtarget_ and _Target Profile_ accordingly.
+##### Default packages
+**Deselect** conflicting Packages:
 
+- `Base system` -> `< >` `dnsmasq`
+- `Network` -> `< >` `odhcpd-ipv6only`
+
+By default LibreMesh uses `dnsmasq-dhcpv6` instead of the OpenWrt's default `dnsmasq` and `odhcpd-ipv6only`.
 
 **Deselect** erroneous feeds locations:
 
-- Image configuration → Separate feed repositories → Enable feed libremesh
-- Image configuration → Separate feed repositories → Enable feed profiles
+- `Image configuration` -> `Separate feed repositories` -> `< >` `Enable feed libremesh` 
+- `Image configuration` -> `Separate feed repositories` -> `< >` `Enable feed profiles`
 
-**Deselect** problematic packages:
+OpenWrt packages are available from the download server https://downloads.openwrt.org.   
+Remove LibreMesh repositories from this list since precompiled packages will not be available from there.    
+Precompiled LibreMesh packages are available from https://feed.libremesh.org/.    
+These are installable:
+- via package manager directly on the router
+- via ImageBuilder during the firmware generation
 
-- Base system -> dnsmasq
-- Network -> odhcpd-ipv6only
+##### Saving space and RAM
 
 Optionally, **deselect** unused packages:
-- Network -> ppp
+- `Network` -> `< >` `ppp`
+- `Network` -> `< >` `ppp-mod-pppoe`
+- `Kernel Modules` -> `Network Support` -> `< >` `kmod-ppp`
+- `Kernel Modules` -> `Network Support` -> `< >` `kmod-pppoe`
+- `Kernel Modules` -> `Network Support` -> `< >` `kmod-pppox`
 
-If you local community has a profile in the [network-profiles repository](https://github.com/libremesh/network-profiles/), you can select it in:
+Refers to [Packages Selection](../guide/packages-selection#saving-space-and-ram) for a list of other optionally deselectable packages.
 
-- LibreMesh -> network-profile -> profile-your_community-your_profile
+##### LibreMesh packages
+**Select** (press space until when an asterisk appears, like `<*>`) LibreMesh packages:
 
-::: tip NOTE
-Network profiles are the specific configuration from the communities, and are stored in this collective 
-[repository](https://github.com/libremesh/network-profiles/), but they can also be kept locally, depending on how every community network manages itself. For more instructions on how to create a profile or how to use a local one, check out the [network profiles page](../guide/network-profiles).
-:::
+![menuconfig1](/buildroot-menuconfig1.webp)
+
+* `LibreMesh` → `Offline Documentation` → `<*>` `lime-docs-minimal` (LibreMesh minimal documentation)
+* `LibreMesh` → `<*>` `lime-app` (LimeApp) **(optional)**
+* `LibreMesh` → `<*>` `lime-hwd-openwrt-wan` (Respect openwrt wan interface as default)
+* `LibreMesh` → `<*>` `lime-proto-anygw` (LibreMesh anygw proto support)
+* `LibreMesh` → `<*>` `lime-proto-babeld` (LibreMesh babeld proto support)
+* `LibreMesh` → `<*>` `lime-proto-batadv` (LibreMesh batman-adv proto support)
+* `LibreMesh` → `<*>` `shared-state`
+* `LibreMesh` → `<*>` `shared-state-async` **(optional)**
+  * `<*>` `shared-state-babeld_hosts` (babeld-hosts module for shared-state)
+  * `<*>` `shared-state-bat_hosts` (bat-hosts module for shared-state) **(optional)**
+  * `<*>` `shared-state-nodes_and_links` (nodes_and_links module for shared-state)
+* `LibreMesh` -> `<*>` `babeld-auto-gw-mode`
+* `LibreMesh` -> `<*>` `check-date-http` (Keep local date under NTP too far away skew) **(optional)**
+* `LibreMesh` -> `<*>` `Offline Documentation` -> `lime-docs` (LibreMesh full documentation) **(optional)**
+* `LibreMesh` -> `<*>` `lime-debug` (libremesh debug utils) **(optional)**
+
+**Optional packages** are recommended but not mandatory for a working LibreMesh network.    
+Consider avoiding to select these packages `only` if the created image is too large and does not fit in the router memory.
 
-**Select** (press space until when an asterisk appears, like `<*>`) LibreMesh packages:
+Additionally and optionally, httpS for the web interface can be enabled selecting (beware that the web interace will be shown as *not trusted*):
+
+- `Utilities` -> `Encryption` -> `<*>` `px5g-standalone`
 
-* LibreMesh → Offline Documentation → lime-docs-minimal (LibreMesh minimal documentation)
-* LibreMesh → lime-app (LibreMeshApp)
-* LibreMesh → lime-hwd-openwrt-wan (Respect openwrt wan interface as default)
-* LibreMesh → lime-proto-anygw (LibreMesh anygw proto support)
-* LibreMesh → lime-proto-babeld (LibreMesh babeld proto support)
-* LibreMesh → lime-proto-batadv (LibreMesh batman-adv proto support)
-* LibreMesh → shared-state
-** shared-state-babeld_hosts (babeld-hosts module for shared-state)
-** shared-state-bat_hosts (bat-hosts module for shared-state)
-** shared-state-nodes_and_links (nodes_and_links module for shared-state)
-* LibreMesh -> babeld-auto-gw-mode
+If you planning to use encrypted 802.11s mesh, you need to make sure to have the `wpad-mesh-*`, not `wpad-basic-*` package, where `*` is `mbedtls`, `openssl` or `wolfssl`. OpenWrt since branch 23.05 by default uses `mbedtls`.
+- `Network` -> `WirelessAPD` -> `< >` `wpad-basic-mbedtls`
+- `Network` -> `WirelessAPD` -> `<*>` `wpad-mesh-mbedtls`
 
 ::: tip NOTE
-If after the compilation you don't see the compiled image in the `bin/targets/.../.../` folder, it is possible that your router has such a small flash memory that the aforementioed packages don't fit in it (it can happen also with routers having 8 MB of flash memory when selecting huge packages to be included). In this case, you can remove the `.config` generated packages list and repeat the packages selection without including `lime-app`. If the compiled image is still too large, try selecting only `lime-proto-anygw`, `lime-proto-batadv` and `lime-proto-babeld` or following [this guide](https://openwrt.org/docs/guide-user/additional-software/saving_space).
+In order to have additional packages, the easiest way is to select them in menuconfig. More packages can be installed afterwards via `apk` or the older `opkg`, but some of these require a specific kernel configuration to be in place. This can be achieved following [these additional instructions dealing with kernel vermagic](../development/hacking/kernel_vermagic.md) Beware that this will increase noticeably the time and storage space required for the compilation.
 :::
 
-Some more packages are recommended but not mandatory for a working LibreMesh network. Consider avoiding to select the following packages _only_ if the created image is too large and does not fit in the router memory.
+#### Save the configuration
+Save the configuration and exit.
 
-- LibreMesh -> check-date-http (Keep local date under NTP too far away skew)
-- LibreMesh -> Offline Documentation -> lime-docs (LibreMesh full documentation)
-- LibreMesh -> lime-debug (libremesh debug utils)
+#### Additional files
 
-Additionally and optionally, httpS for the web interface can be enabled selecting (beware that the web interace will be shown as *not trusted*):
+At this stage there is the possibility to include custom files in the compiled firmware image. For this, you will have to create, inside the `openwrt/` directory, a `files/` directory containing the directory structure and files you want to add. For example, if you want to have a `/etc/config/lime-community` file you need to do the following:
 
-- Utilities -> Encryption -> px5g-standalone
+``` sh
+mkdir -p files/etc/config/
+touch files/etc/config/lime-community
+```
 
-Finally, also the 802.11s mesh connections can be password protected, this will require a specific configuration and this package to be selected:
+and then edit the newly created `lime-community` file including your custom content. If a file from a package has the same name and path as a file in this directory, it will be overwritten. This is a quick way to include a custom configuration file, without the need to create an online [network profile](../guide/network-profiles).
 
-- Network -> WirelessAPD -> wpad-mesh-openssl
 
-and this to be **de**-selected:
+##### Network Profiles
+If you local community has a profile in the [network-profiles repository](https://github.com/libremesh/network-profiles/), you can select it in:
+
+- LibreMesh -> network-profile -> profile-your_community-your_profile
 
-- Network -> WirelessAPD -> wpad-basic-mbedtls
+![menuconfig2](/buildroot-menuconfig2.webp)
 
 ::: tip NOTE
-In order to have additional packages, the easiest way is to select them in menuconfig. More packages can be installed afterwards via +opkg+, but some of these require a specific kernel configuration to be in place. This can be achieved following link:development-kernel_vermagic.html[these additional instructions dealing with kernel vermagic]. Beware that this will increase noticeably the time and storage space required for the compilation.
+Network profiles are the specific configuration from the communities, and are stored in this collective 
+[repository](https://github.com/libremesh/network-profiles/), but they can also be kept locally, depending on how every community network manages itself. For more instructions on how to create a profile or how to use a local one, check out the [network profiles page](../guide/network-profiles).
 :::
 
-Save and exit.
 
-At this stage there is the possibility to include custom files in the compiled firmware image. For this, you will have to create, inside the `openwrt/` directory, a `files/` directory containing the directory structure and files you want to add. For example, if you want to have a `/etc/config/lime-community` file you need to do the following:
+### Using make defconfig
 
-``` sh
-mkdir -p files/etc/config/
-touch files/etc/config/lime-community
+#### export target-subtarget to env
+``` sh-vue
+export TARGET={{ build.target }}
+export ARCH=$(curl -s https://downloads.openwrt.org/snapshots/.targets.json | \
+    sed 's/\//-/' | jq -r '."${TARGET}"')
 ```
 
-and then edit the newly created `lime-community` file including your custom content. If a file from a package has the same name and path as a file in this directory, it will be overwritten. This is a quick way to include a custom configuration file, without the need to create an online [network profile](../guide/network-profiles).
+#### configure
 
-.Finally, compile the images
-``` sh
-make -j$(nproc)
+#### Target, subtarget and generic configs
+
+```sh
+cat << EOF > .config
+CONFIG_TARGET_${TARGET}=y
+CONFIG_TARGET_${TARGET}_${SUBTARGET}=y
+CONFIG_TARGET_ROOTFS_INITRAMFS=y
+CONFIG_TARGET_MULTI_PROFILE=y
+CONFIG_TARGET_PER_DEVICE_ROOTFS=y
+# CONFIG_FEED_libremesh is not set
+# CONFIG_FEED_profiles is not set
+CONFIG_IMAGEOPT=y
+CONFIG_VERSIONOPT=y
+CONFIG_KERNEL_BUILD_USER=\"builder\"
+CONFIG_KERNEL_BUILD_DOMAIN=\"buildhost\"
+# CONFIG_VERSION_CODE_FILENAMES is not set
+EOF
+make defconfig
+```
+
+#### Kernel modules (optional)
+Optional build all kernel modules to later expose them in an http server
+Needed to install via the package manager packages that depend on non-defaults kernel modules.
+```sh
+cat << EOF >> .config
+CONFIG_DEVEL=y
+CONFIG_ALL_KMODS=y
+CONFIG_ALL_NONSHARED=y
+EOF
+make defconfig
 ```
 
-If everything goes well you should find the produced binaries inside the +bin/+ directory.
+#### LibreMesh packages
+```sh
+cat << EOF >> .config
+# CONFIG_PACKAGE_dnsmasq is not set
+# CONFIG_PACKAGE_odhcpd-ipv6only is not set
+# CONFIG_PACKAGE_ppp is not set
+# CONFIG_PACKAGE_ppp-mod-pppoe is not set
+CONFIG_PACKAGE_kmod-ppp=m
+CONFIG_PACKAGE_kmod-pppoe=m
+CONFIG_PACKAGE_kmod-pppox=m
+CONFIG_PACKAGE_profile-libremesh-suggested-packages=y
+EOF
+make defconfig
+```
 
-== Emulating on your computer with qemu
+#### Router profile
+Selects the router profile based on the compatible string:
 
-Its possible to emulate a image compiled for x86_64 architecture. See [script](https://github.com/libremesh/lime-packages/tree/master/tools) qemu_dev_start.sh and qemu_dev_stop.sh scripts.
+```
+echo "CONFIG_TARGET_DEVICE_ath79_generic_DEVICE_librerouter_librerouter-v1=y" >> .config
+make defconfig
+```
 
-::: tip NOTE
-You will be running something like:
-``` sh
-sudo ./qemu_dev_start openwrt-x86-64-combined-ext4.img openwrt-x86-64-ramfs.bzImage
+## Build Libremesh
+
+Finally, compile the images
+```sh
+make -j$(nproc)
 ```
-More information in [TESTING.md](https://github.com/libremesh/lime-packages/blob/master/TESTING.md)
+Refers to OpenWrt [make tips](https://openwrt.org/docs/guide-developer/toolchain/use-buildsystem#make_tips) for detailed options.
+
+If everything goes well you should find the produced binaries inside the `bin/` directory.
 
+::: tip NOTE
+If after the compilation you don't see the compiled image in the `bin/targets/.../.../` folder, it is possible that your router has such a small flash memory that the aforementioed packages don't fit in it (it can happen also with routers having 8 MB of flash memory when selecting huge packages to be included). In this case, you can remove the `.config` generated packages list and repeat the packages selection without including `lime-app`. If the compiled image is still too large, try selecting only `lime-proto-anygw`, `lime-proto-batadv` and `lime-proto-babeld` or following [this guide](https://openwrt.org/docs/guide-user/additional-software/saving_space).
 :::
+
+Refers to the pages under **Development guide** [testing](/development/testing) and [virtualizing](/development/virtualizing)
+for emulating on your computer with qemu.