Go to file
Nikolai Merinov 469e1eb8a8 BuildSystem: Provide Overlay Feeds base infrastructure implementation
Problem: OpenWRT Build system provide no way to extend package from 3rd party feed.
As a result in order to manage CVE patches or small modification to a single package
we should make copy of package in feeds that we own and monitor any changes in the
package original feed to not miss upstream updates.

Solution: Include all $(PKG_DIR_NAME)/Makefile.append files as part of first
$(eval $(call BuildPackage,packagename)) call in original $(PKG_DIR_NAME)/Makefile.
Add append directories to PKG_FILE_DEPENDS in order to invalidate build when
append files changed.
Together with this change provide several useful functions and variables:

Variable $(THISDIR) -- defined in context of Makefile.append files to and points to
the directory where Makefile.append recipe. Can be used to find additional patches,
config fragments, etc.

Variable $(OVERLAY_PATCHES) -- can be used to provide additional patch files for package
sources in the following manner:

    OVERLAY_PATCHES := $(OVERLAY_PATCHES) $(THISDIR)/patches/filename.patch
    OVERLAY_PATCHES := $(OVERLAY_PATCHES) $(wildcard $(THISDIR)/patches/*.patch)

Variable $(newline) -- contains single "\n" symbol. Required to append/prepend
OpenWRT multiline variables with additional line.

Functions (append,VARNAME,value[,override]) -- used to append "value" string to variable VARNAME.
Behave like "+=" with two exceptions:
 1. Append "value" without extra space before the value
 2. The "value" expanded immediately before the assignment, while VARNAME is treated
    as recursive expand variable. Such behavior allow you to use $(THISDIR) variable
    together with "append" function. For example the following call will expand
    $(THISDIR) immediately:

    $(call append,Package/helloworld/config,$(newline)source "$(THISDIR)/Config.in")

Function (prepend,VARNAME,value[,override]) -- used to prepend "value" string to variable VARNAME.
Shares "append" function behavior regards expansion time. In order to append string
with delayed expansion time you can replace $(...) with $$(...). For exaple the
following call will delay $(Build/IncludeOverlay) expansion:

    $(call prepend,BuildPackage,$$(Build/IncludeOverlay)$(newline))

Function (remove,VARNAME,value[,override]) -- behave like "filter-out" function, but allow to
control expansion time of the passed "value".

Function (rewrite,VARNAME,value[,override]) -- generalized function that allow arbitrary change
of VARNAME variable value controlling "value" expansion time.

All this functions support optional last argument that allow to modify "override VARNAME" instead
of non-override version of VARNAME.

References: PCF-1615
Signed-off-by: Ivan Efimov <i.efimov@inango-systems.com>
Signed-off-by: Nicolai Scurtu <n.scurtu@inango-systems.com>
Signed-off-by: Vadym Omelchuk <v.omelchuk@inango-systems.com>
Signed-off-by: Vladimir Shulika <v.shulika@inango-systems.com>
Signed-off-by: Nikolai Merinov <n.merinov@inango-systems.com>
2025-09-15 13:46:17 +03:00
.devcontainer/ci-env
.github CI: labeler: Add stm32 target 2024-11-28 18:49:21 +00:00
.gitlab prplMesh: bump to master-2025-09-11 2025-09-15 09:36:39 +00:00
.testbed ci: testbed: OSPv2: update flashing procedure to the new flash layout 2025-09-13 06:16:11 +00:00
.vscode meta: VS Code: add "Git: Always Sign Off" setting 2024-10-03 17:18:51 +02:00
config build: add support for checksec.sh based mitigation reports 2025-07-31 15:20:37 +00:00
include BuildSystem: Provide Overlay Feeds base infrastructure implementation 2025-09-15 13:46:17 +03:00
LICENSES
package kmod-ipt-ipopt: add conditional dependency on kmod-nf-conntrack 2025-08-01 08:23:54 +00:00
profiles prplMesh: bump to master-2025-09-11 2025-09-15 09:36:39 +00:00
scripts scripts: prplos_version: adapt for prplware Git version tags 2025-09-11 06:10:24 +00:00
target kernel: move kernel-6.6 file to linux/generic directory 2025-07-31 15:27:59 +00:00
toolchain toolchain: glibc: Update glibc 2.38 to recent HEAD 2025-07-27 19:47:26 +02:00
tools tools: checksec.sh: fix build breakage caused by wrong PKG_MIRROR_HASH 2025-07-31 15:30:00 +00:00
.gitattributes
.gitignore
.gitlab-ci.yml ci: build: OSPv2: use standard build workflow 2025-09-13 06:16:08 +00:00
BSDmakefile
Config.in
COPYING
feeds.conf.default feeds.conf.default: pin to latest openwrt-24.10 branch states 2025-07-31 15:29:59 +00:00
Makefile build,base-files: propagate prplOS version into build artifacts 2025-07-31 15:18:10 +00:00
README.md
rules.mk build: add comments to makefiles 2024-11-28 18:47:03 +00:00

OpenWrt logo

OpenWrt Project is a Linux operating system targeting embedded devices. Instead of trying to create a single, static firmware, OpenWrt provides a fully writable filesystem with package management. This frees you from the application selection and configuration provided by the vendor and allows you to customize the device through the use of packages to suit any application. For developers, OpenWrt is the framework to build an application without having to build a complete firmware around it; for users this means the ability for full customization, to use the device in ways never envisioned.

Sunshine!

Download

Built firmware images are available for many architectures and come with a package selection to be used as WiFi home router. To quickly find a factory image usable to migrate from a vendor stock firmware to OpenWrt, try the Firmware Selector.

If your device is supported, please follow the Info link to see install instructions or consult the support resources listed below.

An advanced user may require additional or specific package. (Toolchain, SDK, ...) For everything else than simple firmware download, try the wiki download page:

Development

To build your own firmware you need a GNU/Linux, BSD or macOS system (case sensitive filesystem required). Cygwin is unsupported because of the lack of a case sensitive file system.

Requirements

You need the following tools to compile OpenWrt, the package names vary between distributions. A complete list with distribution specific packages is found in the Build System Setup documentation.

binutils bzip2 diff find flex gawk gcc-6+ getopt grep install libc-dev libz-dev
make4.1+ perl python3.7+ rsync subversion unzip which

Quickstart

  1. Run ./scripts/feeds update -a to obtain all the latest package definitions defined in feeds.conf / feeds.conf.default

  2. Run ./scripts/feeds install -a to install symlinks for all obtained packages into package/feeds/

  3. Run make menuconfig to select your preferred configuration for the toolchain, target system & firmware packages.

  4. Run make to build your firmware. This will download all sources, build the cross-compile toolchain and then cross-compile the GNU/Linux kernel & all chosen applications for your target system.

The main repository uses multiple sub-repositories to manage packages of different categories. All packages are installed via the OpenWrt package manager called opkg. If you're looking to develop the web interface or port packages to OpenWrt, please find the fitting repository below.

  • LuCI Web Interface: Modern and modular interface to control the device via a web browser.

  • OpenWrt Packages: Community repository of ported packages.

  • OpenWrt Routing: Packages specifically focused on (mesh) routing.

  • OpenWrt Video: Packages specifically focused on display servers and clients (Xorg and Wayland).

Support Information

For a list of supported devices see the OpenWrt Hardware Database

Documentation

Support Community

  • Forum: For usage, projects, discussions and hardware advise.
  • Support Chat: Channel #openwrt on oftc.net.

Developer Community

License

OpenWrt is licensed under GPL-2.0