1 ![OpenWrt logo](include/logo.png)
3 OpenWrt Project is a Linux operating system targeting embedded devices. Instead
4 of trying to create a single, static firmware, OpenWrt provides a fully
5 writable filesystem with package management. This frees you from the
6 application selection and configuration provided by the vendor and allows you
7 to customize the device through the use of packages to suit any application.
8 For developers, OpenWrt is the framework to build an application without having
9 to build a complete firmware around it; for users this means the ability for
10 full customization, to use the device in ways never envisioned.
16 Built firmware images are available for many architectures and come with a
17 package selection to be used as WiFi home router. To quickly find a factory
18 image usable to migrate from a vendor stock firmware to OpenWrt, try the
21 * [OpenWrt Firmware Selector](https://firmware-selector.openwrt.org/)
23 If your device is supported, please follow the **Info** link to see install
24 instructions or consult the support resources listed below.
28 An advanced user may require additional or specific package. (Toolchain, SDK, ...) For everything else than simple firmware download, try the wiki download page:
30 * [OpenWrt Wiki Download](https://openwrt.org/downloads)
34 To build your own firmware you need a GNU/Linux, BSD or macOS system (case
35 sensitive filesystem required). Cygwin is unsupported because of the lack of a
36 case sensitive file system.
40 You need the following tools to compile OpenWrt, the package names vary between
41 distributions. A complete list with distribution specific packages is found in
42 the [Build System Setup](https://openwrt.org/docs/guide-developer/build-system/install-buildsystem)
46 binutils bzip2 diff find flex gawk gcc-6+ getopt grep install libc-dev libz-dev
47 make4.1+ perl python3.7+ rsync subversion unzip which
52 1. Run `./scripts/feeds update -a` to obtain all the latest package definitions
53 defined in feeds.conf / feeds.conf.default
55 2. Run `./scripts/feeds install -a` to install symlinks for all obtained
56 packages into package/feeds/
58 3. Run `make menuconfig` to select your preferred configuration for the
59 toolchain, target system & firmware packages.
61 4. Run `make` to build your firmware. This will download all sources, build the
62 cross-compile toolchain and then cross-compile the GNU/Linux kernel & all chosen
63 applications for your target system.
65 ### Related Repositories
67 The main repository uses multiple sub-repositories to manage packages of
68 different categories. All packages are installed via the OpenWrt package
69 manager called `opkg`. If you're looking to develop the web interface or port
70 packages to OpenWrt, please find the fitting repository below.
72 * [LuCI Web Interface](https://github.com/openwrt/luci): Modern and modular
73 interface to control the device via a web browser.
75 * [OpenWrt Packages](https://github.com/openwrt/packages): Community repository
78 * [OpenWrt Routing](https://github.com/openwrt/routing): Packages specifically
79 focused on (mesh) routing.
81 * [OpenWrt Video](https://github.com/openwrt/video): Packages specifically
82 focused on display servers and clients (Xorg and Wayland).
84 ## Support Information
86 For a list of supported devices see the [OpenWrt Hardware Database](https://openwrt.org/supported_devices)
90 * [Quick Start Guide](https://openwrt.org/docs/guide-quick-start/start)
91 * [User Guide](https://openwrt.org/docs/guide-user/start)
92 * [Developer Documentation](https://openwrt.org/docs/guide-developer/start)
93 * [Technical Reference](https://openwrt.org/docs/techref/start)
97 * [Forum](https://forum.openwrt.org): For usage, projects, discussions and hardware advise.
98 * [Support Chat](https://webchat.oftc.net/#openwrt): Channel `#openwrt` on **oftc.net**.
100 ### Developer Community
102 * [Bug Reports](https://bugs.openwrt.org): Report bugs in OpenWrt
103 * [Dev Mailing List](https://lists.openwrt.org/mailman/listinfo/openwrt-devel): Send patches
104 * [Dev Chat](https://webchat.oftc.net/#openwrt-devel): Channel `#openwrt-devel` on **oftc.net**.
108 OpenWrt is licensed under GPL-2.0