e112fd8e59
Some feeds might need to set the source for their packages in a different directory than the cloned one. For example a feed "test" might be an entire repository and the relevant packages that wants to be included are in the directory "foo". In such scenario the source info in the package will result in something like "feeds/test/foo/network/dnsmasq" instead of an expected entry like "feeds/test/network/dnsmasq". To give a more real-world example, this problem is currently present with OpenWrt SDK where the SDK clone the entire OpenWrt core repository as "base" feeds but the package are present in the "package" directory. This cause every package to have the source entry set to "feeds/base/package/..." conflicting with what a non-SDK build do with setting the source entry to "feeds/base/..." To solve this, actually enable support for "flags" in the feeds script and implement a new option "--root" to set the root directory for the defined feed to an inner directory. The "flags" in the feed script are no more than argument option that can be defined right after the "src-" type in the feed.conf file. This feature was partially implemented but never actually used for anything keeping it dormant with all the core piece there (the pattern regex always accounted for these extra option but they were never passed to the relevant functions) An example of the "--root" flag is the following: src-git --root=package base https://git.openwrt.org/openwrt/openwrt.git;main With "--root" defined, the script will append "_root" to the feed name clone directory and will create a symbolic link named with the feed name and pointing to the feed name clone directory + the value in root. From the previous example: feed name: base -> clone directory: base_root symbolic link: base -> base_root/package The script internally reference the "_root" directory for every update operation and OpenWrt build system transparently use the feed name directory to reference feed packages producing consistent source info entry. Link: https://github.com/openwrt/openwrt/pull/20396 Signed-off-by: Christian Marangi <ansuelsmth@gmail.com> |
||
|---|---|---|
| .devcontainer/ci-env | ||
| .github | ||
| .vscode | ||
| LICENSES | ||
| config | ||
| include | ||
| package | ||
| scripts | ||
| target | ||
| toolchain | ||
| tools | ||
| .gitattributes | ||
| .gitignore | ||
| BSDmakefile | ||
| COPYING | ||
| Config.in | ||
| Makefile | ||
| README.md | ||
| feeds.conf.default | ||
| rules.mk | ||
README.md
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
-
Run
./scripts/feeds update -ato obtain all the latest package definitions defined in feeds.conf / feeds.conf.default -
Run
./scripts/feeds install -ato install symlinks for all obtained packages into package/feeds/ -
Run
make menuconfigto select your preferred configuration for the toolchain, target system & firmware packages. -
Run
maketo 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.
Related Repositories
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
#openwrton oftc.net.
Developer Community
- Bug Reports: Report bugs in OpenWrt
- Dev Mailing List: Send patches
- Dev Chat: Channel
#openwrt-develon oftc.net.
License
OpenWrt is licensed under GPL-2.0