OpenWrt Source Repository
Go to file
Olliver Schinagl 9f0cc3eb11 scripts/kernel_bump: Run script relative to the script dir
Determine the target directory based on the script location, which might
work better in some cases, but at least also allows the script to be ran
from with any location in the OpenWRT repository.

Signed-off-by: Olliver Schinagl <oliver@schinagl.nl>
2024-04-12 18:20:52 +02:00
.devcontainer/ci-env devcontainer: Add development environment for gihub codespace 2023-10-30 23:34:26 +01:00
.github ath25: drop target 2024-03-07 12:15:51 +01:00
LICENSES
config config: select KERNEL_WERROR if building with default GCC version 2024-04-08 01:40:15 +01:00
include treewide: remove implicit SUBTARGET 2024-04-08 21:53:05 +02:00
package lldpd: make management address advertisement controllable 2024-04-12 13:45:48 +02:00
scripts scripts/kernel_bump: Run script relative to the script dir 2024-04-12 18:20:52 +02:00
target mediatek: mt7622: rtl8367c: source code spell fixes 2024-04-12 14:46:32 +02:00
toolchain config: fix CONFIG_GDB appearing in main menuconfig menu 2024-04-09 19:30:41 +02:00
tools tools: zstd: dont override CLI max level 2024-04-09 18:39:36 +02:00
.gitattributes
.gitignore
BSDmakefile
COPYING
Config.in
Makefile build: fix pkg-config detection when inside of a nix-shell 2023-11-02 20:26:32 +01:00
README.md README: replace "MacOSX" with "macOS" 2024-04-01 18:46:30 +02:00
feeds.conf.default
rules.mk rules.mk: make toolchain dirs define more consistent 2023-10-20 16:13:56 +02:00

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