OpenWrt Project is a Linux operating system targeting embedded devices

rim 809db35e0c Improve 4G/LTE support 4 years ago
.github 5781fc6b3f build: Update README & github help 5 years ago
LICENSES 882e301461 LICENSES: include all used licenses in LICENSES directory 3 years ago
config ebcb4f1d0a treewide: fix spelling 'seperate' -> 'separate' 3 years ago
include 0a22cef3bc kernel: bump 5.10 to 5.10.28 3 years ago
package 809db35e0c Improve 4G/LTE support 3 years ago
scripts 7880a64848 build,json: 3rd fixup of default_packages 3 years ago
target 3225241c2b sunxi: add support for H6 boards and OrangePiOnePlus 3 years ago
toolchain acb0788b8e toolchain: gcc: Update to version 10.3.0 3 years ago
tools 1a55a2b112 firmware-utils: add -Wall to most tools 3 years ago
.gitattributes 7fb394b9ab add .gitattributes to prevent the git autocrlf option from messing with CRLF/LF in files 12 years ago
.gitignore 12dbad1a86 gitignore: add .vscode for VS Code users 3 years 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 a17b8eaa2e build: use SPDX license tags 3 years ago
Makefile 1f5e722486 Revert "build: replace which with Bash command built-in" 3 years ago
README.md 1276db918b README: add install command to build requirements 3 years ago
feeds.conf.default 20caa68fec feeds.conf.default: remove freifunk feed 3 years ago
rules.mk af22991e03 build: make sure asm gets built with -DPIC 3 years 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!

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.6+ 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.

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 freenode.net.

Developer Community

License

OpenWrt is licensed under GPL-2.0