User Tools

Site Tools


doc:start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
doc:start [2013/04/23 12:42]
oldcomputerjunk
doc:start [2015/12/29 00:08] (current)
briansmith [Developing]
Line 1: Line 1:
 +====== Documentation ======
 +This is the latest documentation section of the OpenWrt Wiki.
  
 +
 +===== About OpenWrt =====
 +==== Overview ====
 +OpenWrt is a highly extensible GNU/Linux distribution for embedded devices... ​
 +[[about/​start|read more]].\\
 +
 +==== History ====
 +The OpenWrt project started in January 2004... [[about/​history|read more]].
 +
 +==== News and release announcements ====
 +
 +... [[https://​openwrt.org|read more]].
 +
 +==== Conferences and talks on OpenWrt ====
 +
 +... [[about:​talks|read more]].
 +===== Hardware =====
 + ​General Hardware Info: [[doc:​hardware:​start | Hardware Guide ]]
 +
 +==== Supported Target Device Platforms ====
 +Devices that work with OpenWrt: [[toh:​start|Table of Hardware]].
 +
 +==== Adding Peripheral Support ====
 +
 +How to add support for  [[doc:​howto:​hardware.button| hardware buttons ]]
 +
 +General info on [[doc:​hardware:​port.gpio | GPIOs]]
 +
 +Forum post describing how to find and test GPIOs [[https://​forum.openwrt.org/​viewtopic.php?​id=36561 | here]].
 +
 +
 +===== Frequently Asked Questions (FAQ) =====
 +[[doc:​faq|OpenWrt FAQ]]
 +
 +
 +
 +
 +===== Beginners'​ Guide =====
 +OpenWrt allows you to install a very powerful, highly customizable variant of Linux on your router... [[doc:​howto:​user.beginner|read more]].
 +
 +=====Installing OpenWrt====
 +The installation of OpenWrt is device specific... [[doc/​howto/​generic.flashing|read more]].
 +
 +===== Configuring OpenWrt =====
 +
 +==== First Login ====
 +
 +There is no default password in OpenWrt after installation... [[doc/​howto/​firstlogin|read more]].
 +
 +==== Basic Configuration ====
 +After logging in (and setting a new password) you configure your system using UCI or LuCI... [[doc/​howto/​basic.config|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... [[doc/​uci|read more]]\\
 +
 +
 +===== HOWTOs and Recipes =====
 +[[doc:​recipes:​index|Recipes]] and HOWTOs cover tasks possible with OpenWrt, ie: setting up a printer server, using the vanilla firmware, installing packages via opkg and configuration... [[doc:​howto:​start|read more]]
 +
 +
 +
 +===== Building OpenWrt =====
 +These articles focus on compiling OpenWrt sources.
 +
 +^ Page ^ Description ^
 +| [[about:​toolchain|OpenWrt build system โ€” About]] | About OpenWrt build system ​ |
 +| [[doc:​howto:​buildroot.exigence|OpenWrt build system โ€“ Installation]] | Setting up an OpenWrt build system |
 +| [[doc:​howto:​build|OpenWrt build system โ€“ Usage]] | Using the build system to compile OpenWrt |
 +| [[doc:​howto:​buildvm|Build VM]] | Using the build system to compile OpenWrt within a virtual machine |
 +| [[doc:​devel:​feeds|Feeds]] | Working with package feeds |
 +| [[doc:​howto:​obtain.firmware.generate|Image Generator]] | The Image Generator (aka Image builder) lets you create custom images without having to compile or setting up a build system |
 +| [[doc:​howto:​obtain.firmware.sdk|SDK]] | Using the SDK to compile package sources |
 +
 +==== Build HOWTOs ====
 +
 +[[doc:​howtobuild:​start|Build-HOWTOs]] include doing things from scratch and then using the [[about:​toolchain|build system]] to obtain your own firmware (see [[meta:​template_howtobuild]]):​
 +
 +^ Page ^ Description ^
 +| [[doc:​howtobuild:​build.wndr3700|Netgear WNDR3700]] | Build the Netgear WNDR3700 firmware ​ |
 +| [[doc:​howtobuild:​build.dockstar|Seagate Dockstar]] | Build the Seagate Dockstar firmware ​ |
 +| [[doc:​howtobuild:​tl-mr3420.build|TP-Link TL-MR3420]] | Build the TP-Link TL-MR3420 firmware |
 +| [[doc:​howtobuild:​dir-632-a1.build|D-Link DIR-632-A1]] | Build the DIR-632-A1 firmware |
 +| [[doc:​howtobuild:​wireless-router-with-a-3g-dongle|3G-Dongle]] | Build firmware including UMTS-Modem support ​ |
 +| [[doc:​howtobuild:​single.package|Build a Package]] | Compile and build a single package ​ |
 +| [[doc:​howtobuild:​sheevaplug|SheevaPlug]] | Build the SheevaPlug firmware ​ |
 +
 +
 +
 +
 +
 +
 +===== Developing =====
 +Documentation for specific development related tasks.
 +
 +^ Page ^ Description ^
 +^ Hacking ^^
 +| [[doc:​devel:​hw.hacking.first.steps| First Steps]] | First steps on an unsupported device |
 +| [[doc:​devel:​add.new.platform|Add a Platform]] | General considerations for adding new platform support |
 +| [[doc:​devel:​add.new.device|Add a Device]] | How to add support for a new device ​ |
 +^ Kernel stu<​html>&#​64256</​html>​ ^^
 +| [[doc:​devel:​drivers|Drivers]] ​ | Driver information ​  |
 +^ OpenWrt ^^
 +| [[doc:​devel:​debugging|Debugging]] ​   | Debugging ​ |
 +| [[doc:​devel:​env|Build environments]] | Manage different configurations and files in a single Buildroot |
 +| [[doc:​devel:​links.software.libraries| Software Libraries]] | What libraries you could use  |
 +| [[doc:​devel:​crosscompile|Crosscompile]] | Cross compile sources into binaries without packaging them |
 +| [[doc:​devel:​packages|Packages]] ​ | Packaging software |
 +| [[doc:​devel:​feeds|Feeds]] ​       | Working with package feeds |
 +| [[doc:​devel:​dependencies|Dependencies]] | Using dependencies for packages |
 +| [[doc:​devel:​patches|Patches]] ​   | Adding, modifying and refreshing patches |
 +| [[doc:​devel:​bugs|Bugs]] | Reporting and tracking bugs |
 +| [[doc:​devel:​uci-lua|UCI-Lua]] ​   | Lua bindings for UCI |
 +| [[doc:​devel:​luci|LuCI]] ​   | Developing LuCI addons | 
 +| [[doc:​devel:​config-scripting|Config scripting]] | Using UCI configuration files in shell scripts |
 +| [[doc:​devel:​network-scripting|Network scripting]] | Network scripting and protocol handler API |
 +| [[doc:​devel:​security|Security]] ​   | Security Engineering Considerations |
 +| [[doc:​devel:​gdb|GNU Debugger]] ​   | How to use the [[wp>GNU Debugger]] ​ |
 +| [[doc:​devel:​Eclipse|Eclipse IDE]]    | How to use the [[wp>​Eclipse_%28software%29|Eclipse IDE]] including [[wp>GNU Debugger]] ​ |
 +
 +===== Patching =====
 +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 ^
 +^ GIT ^^
 +| [[doc:​patch:​using.git| Using GIT]] | Primer |
 +
 +
 +
 +
 +
 +
 +
 +===== Technical references =====
 +Articles covering background information and technical description of various OpenWrt components.
 +
 +^ Page ^ Description ^
 +^ Utilities ^^
 +| [[doc:​techref:​opkg|OPKG]] | OPKG package manager reference |
 +| [[doc:​techref:​mtd|mtd]] ​  | mtd utility reference |
 +| [[doc:​techref:​sysupgrade|sysupgrade]] ​  | sysupgrade script ​ |
 +| [[doc:​techref:​uci|UCI]] ​  | UCI reference ​ |
 +| [[doc:​techref:​luci|LuCI]] | LuCI reference ([[http://​luci.subsignal.org/​|Homepage]]) ​ |
 +| [[doc:​techref:​netifd|netifd]] | Netifd (Network Interface Daemon) reference ​ |
 +^ Functioning ^^
 +| [[doc:​techref:​Flash.Layout|Flash Layout]] | How data is stored on the flash  |
 +| [[doc:​techref:​flash|Flash]] ​  | About the different types of flash and what to consider ​ |
 +| [[doc:​techref:​filesystems|Filesystems]] ​  | About the different file systems ​ |
 +| [[doc:​techref:​bootloader|The Bootloader]] | About bootloaders ​ |
 +| [[doc:​techref:​process.boot|Booting]] ​     | About the boot process |
 +| [[doc:​techref:​initscripts|Init Scripts]] ​ | Init script implementation reference |
 +| [[doc:​techref:​preinit_mount|Preinit]] ​    | Preinit, mount root, and first boot Scripts |
 +| [[doc:​techref:​block_mount|Block Mount]] ​  | Block Device Mounting |
 +| [[doc:​techref:​hotplug|Hotplug]] ​          | Hotplug ​ |
 +| [[doc:​techref:​requirements.boot.process|Boot & Init Requirements]]| What the new init system needs to do to be feature complete compared to current, and goals for improvement |
 +^ General ^^
 +| [[doc:​techref:​brcm63xx.imagetag]] | Information on the firmware image format for brcm63xx |
 +| [[doc:​techref:​header|TRX vs TRX2 vs BIN]] | Information on the different file types|
 +| [[doc:​techref:​externaldocumentation|External Documentation]] | Links to external documentation |
 +
 +see also [[doc:​techref:​start|Technical Reference]]