Documentation
This is the latest documentation section of the OpenWrt Wiki.
The old OpenWrt manual can be found here: OpenWrt Manual.
About OpenWrt
Overview
OpenWrt is a highly extensible GNU/Linux distribution for embedded devices…
read more.
History
The OpenWrt project started in January 2004… read more.
News and release announcements
… read more.
Supported Devices
Devices that work with OpenWrt: Table of Hardware.
Frequently Asked Questions (FAQ)
Beginners' Guide
OpenWrt allows you to install a very powerful, highly customizable variant of Linux to your router… read more.
Installing OpenWrt
The installation of OpenWrt is device specific… read more.
Configuring OpenWrt
First Login
There is no preset password in OpenWrt!… read more.
Basic Configuration
After first login you can gain access to your router via… 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
Recipes
HowTo's
HOWTOs cover additional 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 |
|---|---|
| Easy Build | Step by step instructions for building a OpenWRT firmware .bin for specific hardware |
| OpenWrt Buildroot — About | About OpenWrt Buildroot |
| OpenWrt Buildroot – Installation | Setting up an OpenWrt build system |
| OpenWrt Buildroot – 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 an 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 |
| ExtRoot | Build firmware with ExtRoot |
| 3G-Dongle | Build firmware including UMTS-Modem support |
| single package | Compile and package only one single package |
Developing
Documentation of specific development related tasks.
| Page | Description |
|---|---|
| Hacking | |
| First Steps | First Steps on an unsupported device |
| Add a platform | General considerations for adding new platform support |
| Add a device | Howto add support for a new device |
| Kernel stuff | |
| drivers | Stuff related to drivers |
| OpenWrt | |
| Debugging | On 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 |
Technical references
Articles covering background information and technical description of various OpenWrt components.
| Page | Description |
|---|---|
| Utilities | |
| 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 |
| Functioning | |
| 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 Booloaders |
| 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 |
| General | |
| 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: 2013/04/23 12:42 by oldcomputerjunk
This text is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.