User Tools

Site Tools



This is the latest documentation section of the OpenWrt Wiki.

About OpenWrt


OpenWrt is a highly extensible GNU/Linux distribution for embedded devices… read more.


The OpenWrt project started in January 2004… read more.

News and release announcements

read more.

Conferences and talks on OpenWrt

read more.


General Hardware Info: Hardware Guide

Supported Target Device Platforms

Devices that work with OpenWrt: Table of Hardware.

Adding Peripheral Support

How to add support for hardware buttons

General info on GPIOs

Forum post describing how to find and test GPIOs here.

Frequently Asked Questions (FAQ)

Beginners' Guide

OpenWrt allows you to install a very powerful, highly customizable variant of Linux on your router… read more.

Installing OpenWrt

The installation of OpenWrt is device specific… read more.

Configuring OpenWrt

First Login

There is no default password in OpenWrt after installation… read more.

Basic Configuration

After logging in (and setting a new password) you configure your system using UCI or LuCI… read more.

Unified Configuration Interface (UCI)

The abbreviation UCI stands for Unified Configuration Interface and is intended to centralize the whole configuration of your OpenWrt… read more

HOWTOs and Recipes

Recipes and HOWTOs cover tasks possible with OpenWrt, ie: setting up a printer server, using the vanilla firmware, installing packages via opkg and configuration… read more

Building OpenWrt

These articles focus on compiling OpenWrt sources.

Page Description
OpenWrt build system — About About OpenWrt build system
OpenWrt build system – Installation Setting up an OpenWrt build system
OpenWrt build system – Usage Using the build system to compile OpenWrt
Build VM Using the build system to compile OpenWrt within a virtual machine
Feeds Working with package feeds
Image Generator The Image Generator (aka Image builder) lets you create custom images without having to compile or setting up a build system
SDK Using the SDK to compile package sources

Build HOWTOs

Build-HOWTOs include doing things from scratch and then using the build system to obtain your own firmware (see template_howtobuild):

Page Description
Netgear WNDR3700 Build the Netgear WNDR3700 firmware
Seagate Dockstar Build the Seagate Dockstar firmware
TP-Link TL-MR3420 Build the TP-Link TL-MR3420 firmware
D-Link DIR-632-A1 Build the DIR-632-A1 firmware
3G-Dongle Build firmware including UMTS-Modem support
Build a Package Compile and build a single package
SheevaPlug Build the SheevaPlug firmware


Documentation for specific development related tasks.

Page Description
First Steps First steps on an unsupported device
Add a Platform General considerations for adding new platform support
Add a Device How to add support for a new device
Kernel stuff
Drivers Driver information
Debugging Debugging
Build environments Manage different configurations and files in a single Buildroot
Software Libraries What libraries you could use
Crosscompile Cross compile sources into binaries without packaging them
Packages Packaging software
Feeds Working with package feeds
Dependencies Using dependencies for packages
Patches Adding, modifying and refreshing patches
Bugs Reporting and tracking bugs
UCI-Lua Lua bindings for UCI
LuCI Developing LuCI addons
Config scripting Using UCI configuration files in shell scripts
Network scripting Network scripting and protocol handler API
GNU Debugger How to use the GNU Debugger
Eclipse IDE How to use the Eclipse IDE including GNU Debugger


Documentation of specific patching related tasks. Namely, how to create the patch(es), and submit them properly to the OpenWrt-dev mailing list.

Page Description
Using GIT Primer

Technical references

Articles covering background information and technical description of various OpenWrt components.

Page Description
OPKG OPKG package manager reference
mtd mtd utility reference
sysupgrade sysupgrade script
UCI UCI reference
LuCI LuCI reference (Homepage)
netifd Netifd (Network Interface Daemon) reference
Flash Layout How data is stored on the flash
Flash About the different types of flash and what to consider
Filesystems About the different file systems
The Bootloader About bootloaders
Booting About the boot process
Init Scripts Init script implementation reference
Preinit Preinit, mount root, and first boot Scripts
Block Mount Block Device Mounting
Hotplug Hotplug
Boot & Init Requirements What the new init system needs to do to be feature complete compared to current, and goals for improvement
brcm63xx.imagetag Information on the firmware image format for brcm63xx
TRX vs TRX2 vs BIN Information on the different file types
External Documentation Links to external documentation
doc/start.txt · Last modified: 2015/11/19 19:04 by hawaii