OpenWrt Project is a Linux operating system targeting embedded devices

Rafał Miłecki 2feedab805 bcm53xx: refresh kernel 6.6 config 22 hours ago
.devcontainer ed5dbbc129 devcontainer: Add development environment for gihub codespace 4 months ago
.github e247763617 ath25: drop target 3 weeks ago
LICENSES 882e301461 LICENSES: include all used licenses in LICENSES directory 3 years ago
config 686cc58c10 kernel: support RISC-V PMU 5 days ago
include e8725a932e treewide: use APK compatible version schema 6 days ago
package 29b8ba75fa sunxi: add support for Orange Pi Zero 3 2 days ago
scripts 3561015efd scripts: Kernel bumper script 2 weeks ago
target 2feedab805 bcm53xx: refresh kernel 6.6 config 22 hours ago
toolchain 8753022aea toolchain: gcc: switch default to 13 4 days ago
tools 80b2288ea3 tools/expat: update to version 2.6.2 2 days ago
.gitattributes 7fb394b9ab add .gitattributes to prevent the git autocrlf option from messing with CRLF/LF in files 12 years ago
.gitignore 13e7a2d19f .gitignore: ignore link if target is included from feed 8 months ago
BSDmakefile a17b8eaa2e build: use SPDX license tags 3 years ago
COPYING 36bb1196d1 COPYING: add COPYING file to specify project licenses 3 years ago
Config.in 009293c52e build: scripts/config - update to kconfig-v5.14 2 years ago
Makefile 86ca7199df build: fix pkg-config detection when inside of a nix-shell 4 months ago
README.md 7d0fb2cc34 build: drop support for python 3.6 10 months ago
feeds.conf.default 11bb5337b8 Revert "feeds: use git-src-full to allow Git versioning" 10 months ago
rules.mk 987458c2e1 rules.mk: make toolchain dirs define more consistent 5 months ago

README.md

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 MacOSX 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.

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 #openwrt on oftc.net.

Developer Community

License

OpenWrt is licensed under GPL-2.0