Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revisionBoth sides next revision
playground:playground [2022/12/19 04:46] – [Using the Image Builder] added odon-nodaplayground:playground [2024/08/06 19:36] – testando mguima
Line 1: Line 1:
 ====== PlayGround ====== ====== PlayGround ======
-~~NOTOC~~ 
  
-<WRAP info+====== Bootlogs ====== 
-The playground is for experimenting. Play around as you like!\\ +==== OEM bootlog ==== 
-This page is for playing around and experimenting only, and can be deleted any time, therefore don't put anything here that shall last long time.\\ +<WRAP bootlog
-Use the [[inbox:start|Inbox]] to create new pages that are WIP, but shall find a permanent place in the wiki once they are considered finished.+<nowiki> 
 +... TBD ... 
 +</nowiki> 
 +</WRAP>\\
  
-Add your content below the line and **leave this note in place.** +====== Bootlogs ====== 
-</WRAP+=== OpenWRT bootlog === 
-----+== System bootlog == 
 +<WRAP bootlog> 
 +<nowiki> 
 +... TBD ..
 +</nowiki
 +</WRAP>\\
  
-===== Template deviceinfo2 (model + version) ===== 
- 
-Works for devices **with** version (RT-AC1200 v1): 
-{{wst>deviceinfo2|RT-AC1200|v1}} 
-Works for devices **with** version (RT-AC1200 v2): 
-{{wst>deviceinfo2|RT-AC1200|v2}} 
- 
-Does not work for devices **without** version (WR6202): 
-{{wst>deviceinfo2|WR6202|}} 
- 
-===== Template deviceinfo (model only) ===== 
- 
-Works work for devices **without** version (WR6202): 
-{{wst>deviceinfo|WR6202}} 
- 
-Does not work for devices **with** version (RT-AC1200 v1) -> always shows both, v1+v2: 
-{{wst>deviceinfo|RT-AC1200|v1}} 
-Does not work for devices **with** version (RT-AC1200 v2) -> always shows both, v1+v2: 
-{{wst>deviceinfo|RT-AC1200|v2}} 
-Does not work for devices **with** version (RT-AC1200 without version) -> always shows both, v1+v2: 
-{{wst>deviceinfo|RT-AC1200|}} 
- 
-===== Template Flash layout ===== 
-^  [[toh:tp-link:archer_c6_v2|TP-Link Archer C6 V2 (EU/RU/JP)]] Flash Layout                                                                                                                                                                                                                                                                                                                                                         |||||||| 
-^ Layer0                                                                      |  raw SPI NOR flash memory chip (**GD25Q64C** [[wp>Serial Peripheral Interface Bus|spi]]0.0: [[https://www.elm-tech.com/ja/products/spi-flash-memory/gd25q64/gd25q64.pdf|GD25Q64C]]) 8192 KiB                                                                                                                                                          ||||||| 
-^ Layer1                                                                      |  mtd0 **//u-boot//** 128 KiB                                                                                                                                                                  | mtd1 **//info//** 64 KiB|   mtd2 **//firmware//** 7808 KiB                                                                                             |||  mtd6 **//tplink//** 128 KiB  |  mtd7 **//art//** 64 KiB  | 
-^ Layer2                                                                      |                                                                                                                                                                                               | | mtd3 **//kernel//** 2440 KiB    |  mtd4 **//rootfs//** 5368 KiB                                                             ||                           | 
-^ <color magenta>mountpoint</color>                                                                                                                                                                                                                                         | |                                  <color magenta>''/''</color>                                                             ||                           | 
-^ filesystem                                                                  |                                                                                                                                                                                               | |                                  [[docs:techref:filesystems#overlayfs|OverlayFS]]                                         ||                           | 
-^ Layer3                                                                      |                                                                                                                                                                                               | |                                                                                    |  mtd5 **//rootfs_data//** 1536 KiB    |                           | 
-^ Size in KiB                                                                  128 KiB                                                                                                                                                                                      |  64 KiB  |  2440 KiB                        |  3832 KiB                                          |  1536 KiB                              128 KiB  |  64 KiB                   | 
-^ Name                                                                        |  **//u-boot//**                                                                                                                                                                                **//info//**  |  **//kernel//**                  |   **//rootfs//**                                  |  **//rootfs_data//**                  |  **//tplink//**  |  **//art//**              | 
-^ <color magenta>mountpoint</color>                                            //none//                                                                                                                                                                                     | |  //none//                        |  <color magenta>''/rom''</color>                    <color magenta>''/overlay''</color>  |  //none//                  //none//  | 
-^ filesystem                                                                  |  //none//                                                                                                                                                                                     | |  //none//                        |  [[docs:techref:filesystems#SquashFS]]              [[docs:techref:filesystems#JFFS2]]    //none//                  //none//  | 
-**''mtd3,4 and 5 sizes are snapshot specific 
-''** 
- 
-====== Using the Image Builder ====== 
-See also: 
-[[docs:guide-developer:imagebuilder_frontends|Image Builder frontends]], 
-[[docs:guide-developer:start#using_the_toolchain|Using the toolchain]], 
-[[docs:guide-developer:toolchain:beginners-build-guide|Quick image building guide]] 
- 
-The Image Builder (previously called the Image Generator) is a pre-compiled environment suitable for creating custom images without the need for compiling them from source. 
-It downloads pre-compiled packages and integrates them in a single flashable image. 
- 
-Doing so is useful if: 
-  * you want to fit more packages in a small flash size 
-  * you want to follow development snapshots 
-  * your device has 32MB or less RAM and opkg does not work properly 
-  * you want to mass-flash dozens of devices and you need a specific firmware setup 
- 
-<WRAP important> 
-The Image Builder images are not identical to official images as they obtain pre-generated packages. 
-When recent/important changes are made, there can be some delay for these packages to propagate and it is best to check that packages were uploaded after the date of the imagebuilder/change. 
-</WRAP> 
- 
-===== Prerequisites ===== 
-<WRAP important> 
-  * The Image Builder runs only in 64-bit Linux. You can however run a 64-bit Linux in PC or VM, e.g. VirtualBox, even from 32-bit Windows. 
-  * The Image Builder has similar prerequisites as the [[docs:guide-developer:toolchain:install-buildsystem|Build system]]. 
-</WRAP> 
- 
-Example dependencies in the most common distros: 
- 
-==== Arch / Manjaro ==== 
-<code bash> 
-sudo pacman -S --needed base-devel ncurses zlib gawk git gettext \ 
-openssl libxslt wget unzip python 
-</code> 
- 
-==== CentOS / Fedora ==== 
-<code bash> 
-sudo dnf install git gawk gettext ncurses-devel zlib-devel \ 
-openssl-devel libxslt wget which @c-development @development-tools \ 
-@development-libs zlib-static which python3 
-</code> 
- 
-==== Debian / Ubuntu ==== 
-<code bash> 
-sudo apt install build-essential libncurses5-dev libncursesw5-dev \ 
-zlib1g-dev gawk git gettext libssl-dev xsltproc rsync wget unzip python 
-</code> 
- 
-===== Obtaining the Image Builder ===== 
-You can download an archive that contains the **Image Builder**, it is usually located in the same download page where you find the firmware image for your device. 
- 
-For example, this is the page where you can download all firmware images for **ath79/generic** devices: 
-[[https://downloads.openwrt.org/snapshots/targets/ath79/generic/]] 
-and you will find a **openwrt-imagebuilder-ath79-generic.Linux-x86_64.tar.xz** archive with the image builder in it. 
-Also, it is always created by the build system because it is needed to create the image file. 
-If the option "**Build the OpenWrt Image Builder**" is enabled, the image builder will be generated in the same folder you find firmware images (''source/bin/targets/xxx'') and you can use it to create more images from the packages you obtained during compilation. 
- 
-===== Usage ===== 
-<WRAP important> 
-All operations should be performed with a non-root user account. 
-</WRAP> 
- 
-Unpack the archive and change the working directory: 
- 
-<code bash> 
-tar -J -x -f openwrt-imagebuilder-*.tar.xz 
-cd openwrt-imagebuilder-*/ 
-</code> 
- 
-The image building can be customized with the following variables: 
- 
-^ Variable ^ Description ^ 
-| ''PROFILE'' | Specifies the target image to build | 
-| ''PACKAGES'' | A list of packages to embed into the image | 
-| ''FILES'' | Directory with custom files to include | 
-| ''BIN_DIR'' | Alternative output directory for the images | 
-| ''EXTRA_IMAGE_NAME'' | Add this to the output image filename (sanitized) | 
-| ''DISABLED_SERVICES'' | The names of services from ''/etc/init.d'' to disable, e.g. ''dhcp'' for dnsmasq | 
- 
-Run ''make help'' to get [[docs:guide-user:additional-software:imagebuilder#detailed_help|detailed help]]. 
- 
-==== Selecting profile ==== 
-The ''PROFILE'' variable specifies the target image to build. 
- 
-<code bash> 
-PROFILE="profile-name" 
-</code> 
- 
-Run ''make info'' to obtain a list of [[docs:guide-user:additional-software:imagebuilder#available_profiles|available profiles]]. 
- 
-==== Selecting packages ==== 
-The ''PACKAGES'' variable allows to include and/or exclude packages in the firmware image. 
-By default (empty PACKAGES variable) the Image Builder will create a minimal image with device-specific kernel and drivers, uci, ssh, switch, firewall, ppp and ipv6 support. 
- 
-<code bash> 
-PACKAGES="pkg1 pkg2 pkg3 -pkg4 -pkg5 -pkg6" 
-</code> 
- 
-The example above will include pkg1, pkg2, pkg3, and exclude pkg4, pkg5, pkg6, note the "-" before each excluded package. 
- 
-You don't need to list all dependencies of the packages you need in this list, the Image Builder uses ''opkg'' to resolve automatically the package dependencies and install other required packages. 
- 
-The list of currently installed packages on your device can be obtained with the following command: 
- 
-<code bash> 
-echo $(opkg list-installed | sed -e "s/\s.*$//") 
-</code> 
- 
-<WRAP important> 
-Many devices are limited in storage capacity and there is no guarantee that the build system will detect when you have added too many packages to fit into the device storage space, which may render the device unbootable if installed. 
-If in doubt, do not go overboard. 
-Use what you had installed on the device last as a guide or create a minimal image first, install it to the device and test what you would like to add first. 
-Consider removing unnecessary packages to [[docs:guide-user:additional-software:saving_space|save firmware space]]. 
-</WRAP> 
- 
-In addition ABI versioned packages such as ''libubus20191227'' or similar may cause problems with image builder. 
-You may get compile errors when these are provided as packages. 
-To avoid issues you should omit them from image builder and let the correct versions be installed via package dependencies. 
-The ''%%--strip-abi%%'' parameter can be used to export a normalized package list. 
- 
-==== Custom packages ==== 
-If there is a custom package or ipk you would prefer to use create a ''packages'' directory if one does not exist and place your custom ipk within this directory. 
- 
-==== Custom files ==== 
-The ''FILES'' variable allows custom configuration files to be included in images built with Image Builder. 
-This is especially useful if you need to change the network configuration from default before flashing, or if you are preparing an image for mass-flashing many devices. 
- 
-<code bash> 
-FILES="files" 
-</code> 
- 
-The ''files'' directory should be placed in the Image Builder root directory where you issue the make command, otherwise specify an absolute/full path. 
- 
-It is strongly recommended to use [[docs:guide-developer:uci-defaults|uci-defaults]] to incrementally integrate only the required customization. 
-This helps minimize conflicts with auto-generated settings which can change between versions. 
- 
-see: [[:docs:guide-user:additional-software:imagebuilder#restricting_root_access|uci-default_example]] 
- 
-==== Building image ==== 
-After you select the appropriate profile, packages and custom files, pass it to the ''make image'' command. 
- 
-<code bash> 
-make image PROFILE="profile-name" PACKAGES="pkg1 pkg2 pkg3 -pkg4 -pkg5 -pkg6" FILES="files" 
-</code> 
- 
-After the make command is finished, the generated images are stored in the bin///device-architecture// directory, just like if you were compiling them. 
- 
-The built image will be found under the subdirectory ''./bin/targets/<target>/generic'' or look inside .''/build_dir/'' for a files ''*-squashfs-sysupgrade.bin'' and ''*-squashfs-factory.bin'' (e.g. ''/build_dir/target-mips_24kc_musl/linux-ar71xx_tiny/tmp/openwrt-18.06.2-ar71xx-tiny-tl-wr740n-v6-squashfs-factory.bin'') 
- 
-==== Cleaning up ==== 
-To clean up temporary build files and generated images, use the ''make clean'' command. 
- 
-==== Examples ==== 
-The following example shows: 
-  * Creating the directory for the configuration files. 
-  * Using ''scp'' to transfer ''uci'' configuration files from a WL500GP router to the ''files/etc/config'' directory. 
-  * Generating an image for WL500GP with custom packages and ''uci'' configuration files. 
- 
-<code bash> 
-mkdir -p files/etc/config 
-scp root@192.168.1.1:/etc/config/network files/etc/config/ 
-scp root@192.168.1.1:/etc/config/wireless files/etc/config/ 
-scp root@192.168.1.1:/etc/config/firewall files/etc/config/ 
-make image PROFILE="wl500gp" PACKAGES="nano openvpn -ppp -ppp-mod-pppoe" FILES="files" 
-</code> 
- 
-===== Troubleshooting ===== 
-  - Did you run everything as a non-root user? 
-  - Check the logged output, are there package issues (conflicts, improper names)? 
-  - Check the logged output, did you exceed maximum space? 
-  - Check the logged output, are there other obvious errors? 
-  - Wait a few hours/day(s) upstream packages may be in an inconsistent state especially on master/snapshot 
-  - Verify you have a supported OS, prerequisites, file system and path naming 
- 
-===== Extras ===== 
-The topics below go beyond simple usage and aimed at developers and advanced users. 
- 
-==== Detailed help ==== 
-See also: [[https://github.com/openwrt/openwrt/blob/master/target/imagebuilder/files/Makefile|ImageBuilder makefile]] 
- 
-Getting detailed help: 
- 
-<code> 
-# make help 
- 
-Available Commands: 
- help: This help text 
- info: Show a list of available target profiles 
- clean: Remove images and temporary build files 
- image: Build an image (see below for more information). 
- 
-Building images: 
- By default 'make image' will create an image with the default 
- target profile and package set. You can use the following parameters 
- to change that: 
- 
- make image PROFILE="<profilename>" # override the default target profile 
- make image PACKAGES="<pkg1> [<pkg2> [<pkg3> ...]]" # include extra packages 
- make image FILES="<path>" # include extra files from <path> 
- make image BIN_DIR="<path>" # alternative output directory for the images 
- make image EXTRA_IMAGE_NAME="<string>" # Add this to the output image filename (sanitized) 
- make image DISABLED_SERVICES="<svc1> [<svc2> [<svc3> ..]]" # Which services in /etc/init.d/ should be disabled 
- make image ADD_LOCAL_KEY=1 # store locally generated signing key in built images 
- 
-Print manifest: 
- List "all" packages which get installed into the image. 
- You can use the following parameters: 
- 
- make manifest PROFILE="<profilename>" # override the default target profile 
- make manifest PACKAGES="<pkg1> [<pkg2> [<pkg3> ...]]" # include extra packages 
- make manifest STRIP_ABI=1 # remove ABI version from printed package names 
-</code> 
- 
-==== Available profiles ==== 
-Listing available profiles: 
- 
-<code> 
-# make info 
- 
-Available Profiles: 
- 
-Default: 
-    Default Profile 
-    Packages: kmod-usb-core kmod-usb2 kmod-usb-ohci kmod-usb-ledtrig-usbport 
-ai-br100: 
-    Aigale Ai-BR100 
-    Packages: kmod-usb2 kmod-usb-ohci 
-rp-n53: 
-    Asus RP-N53 
-    Packages: 
-rt-n14u: 
-    Asus RT-N14u 
-    Packages: 
-whr-1166d: 
-    Buffalo WHR-1166D 
-    Packages: 
-whr-300hp2: 
-    Buffalo WHR-300HP2 
-    Packages: 
-... 
-</code> 
- 
-==== Building the Image Builder with all packages inside ==== 
-It is possible to use a buildroot to create your own Image Builder and integrate in it all packages so it will be able to generate images without downloading packages. 
- 
-In the graphical configuration, select "**Build the OpenWrt Image Builder**" to build the image builder, then  select **Global Build Settings -> Select all packages by default**, save and exit. 
-You can [[docs:guide-developer:toolchain:use-buildsystem#ignore_build_errors|ignore build errors]] if you encounter unmaintained packages that fail to compile, assuming this doesn't affect kernel and core dependencies. 
- 
-Don't call ''make defconfig'' or leave an old ''.config'' file in the path as ''Select all packages by default'' will only set the package selection to ''[m]'' for packages that are not already configured otherwise! ''make defconfig'' will set most packages to ''[n]'', i.e. //do not build//. 
- 
-==== Adding package repositories ==== 
-The Image Builder you download from the OpenWrt pages is already configured to download any non-default packages from official repositories. 
-The package sources are configured in the ''repositories.conf'' file in the extracted directory. 
-Sources are specified in //opkg// native config format. 
-This can be either the official package repositories or custom generated repositories. 
- 
-An example of the contents of the ''repositories.conf'' from the **openwrt-imagebuilder-18.06.0-rc2-ramips-mt7621.Linux-x86_64.tar.xz**: 
- 
-<code bash> 
-## Place your custom repositories here, they must match the architecture and version. 
-# src/gz %n http://downloads.openwrt.org/releases/18.06.0-rc2 
-# src custom file:///usr/src/openwrt/bin/ramips/packages 
- 
-## Remote package repositories 
-src/gz openwrt_core http://downloads.openwrt.org/releases/18.06.0-rc2/targets/ramips/mt7621/packages 
-src/gz openwrt_base http://downloads.openwrt.org/releases/18.06.0-rc2/packages/mipsel_24kc/base 
-src/gz openwrt_luci http://downloads.openwrt.org/releases/18.06.0-rc2/packages/mipsel_24kc/luci 
-src/gz openwrt_packages http://downloads.openwrt.org/releases/18.06.0-rc2/packages/mipsel_24kc/packages 
-src/gz openwrt_routing http://downloads.openwrt.org/releases/18.06.0-rc2/packages/mipsel_24kc/routing 
-src/gz openwrt_telephony http://downloads.openwrt.org/releases/18.06.0-rc2/packages/mipsel_24kc/telephony 
- 
-## This is the local package repository, do not remove! 
-src imagebuilder file:packages 
-</code> 
- 
-The ''repositories.conf'' in an imagebuilder you compile from source will lack the "Remote package repositories" links. 
- 
-If you want to add a custom local repository, copy the ''%%src custom file:///usr/src/openwrt/bin/ramips/packages%%'' line and modify it to point to the local folder where you have your packages and package lists ([[https://downloads.openwrt.org/releases/21.02.3/targets/ramips/mt7621/packages/Packages|example package list]]). 
-If you have problems with using you local repository because the "Signature check failed" then remove the line ''option check_signature'' from ''repositories.conf'' 
- 
-If you have custom repositories online, copy and modify the ''%%src/gz reboot http://downloads.openwrt.org/snapshots%%'' line instead. 
- 
-NOTE: if you want to override packages coming from an existing feed, you must write your custom feed ABOVE the line of the package feed containing the packages you want to override, as shown in the examples above. 
- 
-==== Restricting root access ==== 
-Create a non-privileged admin user and lock root password. 
-Configure privilege elevation with sudo. 
-Set up key-based authentication and disable password authentication for Dropbear. 
- 
-<code bash> 
-mkdir -p files/etc/uci-defaults 
-cat << "EOF" > files/etc/uci-defaults/99-custom 
-USER_NAME="admin" 
-USER_GROUP="admin" 
-USER_SSHPUB="SSH_PUBLIC_KEY" 
-USER_SHELL="/bin/ash" 
-SUDO_USER="root" 
-SUDO_GROUP="sudo" 
-SUDO_GID="27" 
-uci set dropbear.@dropbear[0].PasswordAuth="0" 
-uci set dropbear.@dropbear[0].RootPasswordAuth="0" 
-uci commit dropbear 
-/etc/init.d/dropbear restart 
-passwd -l "${SUDO_USER}" 
-groupadd -r -g "${SUDO_GID}" "${SUDO_GROUP}" 
-touch /etc/environment 
-cat << EOI > /etc/sudoers.d/00-custom 
-%${SUDO_GROUP} ALL=(ALL) ALL 
-EOI 
-groupadd "${USER_GROUP}" 
-useradd -m -g "${USER_GROUP}" -G "${SUDO_GROUP}" \ 
--s "${USER_SHELL}" "${USER_NAME}" 
-passwd -d "${USER_NAME}" 
-USER_HOME="$(eval echo ~"${USER_NAME}")" 
-mkdir -p "${USER_HOME}"/.ssh 
-cat << EOI > "${USER_HOME}"/.ssh/authorized_keys 
-${USER_SSHPUB} 
-EOI 
-chown -R "${USER_NAME}:${USER_GROUP}" "${USER_HOME}" 
-chmod -R go= "${USER_HOME}" 
-EOF 
-make image FILES="files" PACKAGES="nano shadow sudo" 
-</code> 
- 
-==== Adding/modifying profiles ==== 
- 
-<WRAP important> 
-Examples below may contain version dependent / legacy information and are for informational purposes. They are very low level so expect to have a good level of skill and familiarity with the ImageBuilder / OpenWrt in general.  
-</WRAP> 
- 
-The image building is tied to the profile names. 
-If you add a new profile without also adding an appropriate macro to the image-generation Makefile, no suitable firmware file will get generated when using the custom profile. 
-Remove the ''/tmp'' directory to properly apply the modified package selection from profiles. 
- 
-The location of the profiles for the pre-compiled package for //brcm47xx-for-Linux-i686// was //target/linux/brcm47xx/profiles/// 
- 
-Remarkably, all that needs to be done to add a new profile, is to add a new file to the //profiles// directory. 
-//While this may have been the case in earlier releases, for 17.01, it appears that manual editing of ''.targetinfo'' is also required.// 
- 
-Here is what the //profiles/100-Broadcom-b43.mk// profile file looks like: 
- 
-<code bash> 
-define Profile/Broadcom-b43 
- NAME:=Broadcom BCM43xx WiFi (default) 
- PACKAGES:=kmod-b43 kmod-b43legacy 
-endef 
- 
-define Profile/Broadcom-b43/Description 
- Package set compatible with hardware using Broadcom BCM43xx cards 
-endef 
-$(eval $(call Profile,Broadcom-b43)) 
-</code> 
- 
-Alternately edit the hidden .profile.mk file at the top level directory of the image builder and manually add the names of the desired packages to be added to the output image. 
-An "ls -a" will reveal the files hidden in the various directories. 
- 
-==== Removing useless files from firmware ==== 
-<WRAP important> 
-This is not a standard feature of the Image Builder. 
- 
-It is highly recommended that you test file removal prior to incorporating such changes at the image builder level or that you have low level means to recover a device before attempting this type of mod, as bricking / non booting may result. 
- 
-Note that it requires patching of the ''Makefile'' 
- 
-It is based on older Chaos Calmer era code... and not applicable to modern ImageBuilders but useful as a reference... 
-</WRAP> 
- 
-Create file ''files_remove'' with full filenames: 
- 
-<code bash> 
-/lib/modules/3.10.49/ts_bm.ko 
-/lib/modules/3.10.49/nf_nat_ftp.ko 
-/lib/modules/3.10.49/nf_nat_irc.ko 
-/lib/modules/3.10.49/nf_nat_tftp.ko 
-</code> 
- 
-Patch Makefile: 
- 
-<code diff> 
- ifneq ($(USER_FILES),) 
-  $(MAKE) copy_files 
- endif 
-+ 
-+ifneq ($(FILES_REMOVE),) 
-+ @echo 
-+ @echo Remove useless files 
-+ 
-+ while read filename; do \ 
-+     rm -rfv "$(TARGET_DIR)$$filename"; \ 
-+ done < $(FILES_REMOVE); 
-+endif 
-+ 
-  $(MAKE) package_postinst 
-  $(MAKE) build_image 
-</code> 
- 
-Rebuild firmware: 
- 
-<code bash> 
-make image \ 
-PROFILE="tlwr841" \ 
-PACKAGES="igmpproxy ip iptraf kmod-ipt-nathelper-extra openvpn-polarssl tcpdump-mini -firewall -ip6tables -kmod-ip6tables -kmod-ipv6 -odhcp6c -ppp -ppp-mod-pppoe" \ 
-FILES_REMOVE="files_remove" 
-</code> 
  • Last modified: 2024/11/11 21:03
  • by signoretnt