Differences

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

doc:start [2012/10/07 21:13]
jow old revision restored
doc:start [2014/07/16 14:40] (current)
samsamuel old revision restored
Line 1: Line 1:
====== Documentation ====== ====== Documentation ======
-This is the documentation section of the OpenWrt Wiki, if you want to contribute read [[meta:start|Wiki Maintainers]].\\ +This is the latest documentation section of the OpenWrt Wiki.  
-Supported Devices are listed in the [[toh:start|Table of Hardware]].\\ + 
-The old OpenWrt Manual can be found [[http://kamikaze.openwrt.org/docs/openwrt.html|here]].\\+The old OpenWrt manual can be found here: [[about:start|OpenWrt Manual]].\\ 
 + 
 + 
 +===== 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]]. 
 + 
 +===== 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 pushbuttons ]] 
 + 
 +General info on [[doc:hardware:port.gpio | GPIO's]] 
 + 
 +Forum post describing how to find and test GPIO's [[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 to 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 ===== ===== Configuring OpenWrt =====
-==== Recipes ==== 
-Recipes are articles explaining common OpenWrt setup scenarios like routed client mode. 
-^ Page ^ Description ^ +==== First Login ==== 
-| [[doc:recipes:3gdongle|3g/UMTS dongle]] | Use 3g/UMTS USB Dongle for WAN connection | + 
-| [[doc:recipes:bridgedap|Bridged AP]] | Howto bridge wireless and ethernet in Access Point mode | +There is no preset password in OpenWrt!... [[doc/howto/firstlogin|read more]]. 
-| [[doc:recipes:routedap|Routed AP]] | Howto to put wireless and ethernet in different subnets | + 
-| [[doc:howto:clientmode|Client Mode]] | General discussion of client mode wireless | +==== Basic Configuration ==== 
-| [[doc:recipes:routedclient|Routed Client]] | Howto configure a routed or masqueraded wireless client | +After first login you can gain access to your router via... [[doc/howto/basic.config|read more]].\\ 
-| [[doc:recipes:bridgedclient|Bridged Client (Broadcom)]] | Howto define a wireless client bridge with proprietary Broadcom drivers | + 
-| [[doc:recipes:broadcomwds|WDS (Broadcom)]] | Howto define AP-to-AP WDS with proprietary Broadcom drivers | +==== Unified Configuration Interface (UCI) ==== 
-| [[doc:recipes:atheroswds|WDS (Atheros)]] | Howto setup AP-to-Sta WDS with //madwifi// and //mac80211// drivers | +The abbreviation UCI stands for Unified Configuration Interface and is intended to centralize the whole configuration of your OpenWrt... [[doc/uci|read more]]\\
-| [[doc:recipes:multissid|Multi-SSID]] | Howto define multiple virtual Access Points | +
-| [[doc:recipes:guest-wlan|Guest WLAN]] | Howto define a WLAN for your guests  | +
-| [[doc:recipes:dumbap|Dumb AP]] | Make your router an plain Access Point that's really just that, no routing, no DHCP, no nothing | +
-| [[doc:recipes:install.packages.on.USB-Stick]] | Install packages on an USB-Stick without using extroot |+
-==== HOWTOs ==== +==== Recipes ====  
-[[doc:howto:start|HOWTOs]] cover additional tasks possible with OpenWrt, e.g. setting up a printer server. Using the vanilla firmware, install packages via opkg and set up the configuration. Use the [[meta:templates]] if you want to contribute.+... [[doc/recipes/start|read more]]\\
-^ Cat ^ Page ^ Description ^ +===== HowTo's ===== 
-^ Basic Howtos ^^^ +HOWTOs cover additional tasks possible with OpenWrt, ie: setting up a printer server, using the vanilla firmware, installing packages via opkg and configuration...Projects... Servers.. [[doc:howto:start|read more]]
-|  beginner    | [[doc:howto:generic.overview|Basic Howtos]]      | Stuff explained on the Wiki-Pages for some devices, but not for others | +
-|  beginner    | [[doc:howto:basic.config|Basic Configuration]]    | A help for beginners, an overview for old stagers  | +
-^ Overviews ^^^ +
-|  network    | [[doc:howto:server.overview|Act as Server]]      | Overview over overviews: Offer services over the network (overview)  | +
-|  network    | [[doc:howto:client.overview|Act as Client]]      | Overview over overviews: Use services offered over the network (overview)  | +
-|  administer  | [[doc:howto:webinterface.overview|WebUIs]]        | Web User Interfaces related articles (overview) | +
-|  administer  | [[doc:howto:statistical.data.overview|Statistics]]  | Collect Statistical Data (overview)  | +
-|  sys        | [[doc:howto:log.overview|Logging overview]]      | Log related articles (overview)    | +
-|  network    | [[doc:howto:http.overview|Web Server overview]]  | HTTP Server related articles (overview)  | +
-|  network    | [[doc:howto:proxy.overview|Proxy Server overview]]  | Proxy Server related articles (overview)  | +
-|  network    | [[doc:howto:wireless.overview| Wireless ]]        | Wireless related articles (overview)  | +
-|  network    | [[doc:howto:ipv6.overview|IPv6]]                  | IPv6 related articles (overview)  | +
-|  network    | [[doc:howto:email.overview|E-Mail overview]]      | E-Mail related articles (overview)  | +
-|  network    | [[doc:howto:x.play|more than internet]]          | If you have Double Play/Triple Play/Quadruple Play | +
-|  network    | [[doc:howto:VoIP]]                                | everything VoIP related  | +
-|  network    | [[doc:howto:IPTV]]                                | everything IPTV related  | +
-|  periphery  | [[doc:howto:usb.overview|USB overview]]          | USB related articles (overview)  | +
-|  periphery  | [[doc:howto:printer.overview|Printers]]          | Offer access to a printer connected to OpenWrt over the network  | +
-|  other      | [[doc:howto:database.overview|Databases]]        | Setup [[wp>Database management system]]s like MySQL, PostgreSQL, ...  | +
-|  security    | [[doc:howto:certificates.overview|Certificates]]  | Authentication with the help of certificates  | +
-|  security    | [[doc:howto:vpn.overview|VPN overview]]          | Overview over the usage of VPNs                | +
-|  beginner    | [[doc:howto:basic.understanding|Basic Understanding]]  | A help for beginners to understand their system better  | +
-^ Articles assortment ^^^ +
-|  network    | [[doc:howto:access.modem.through.nat|Access Cable/DSL-Modem]] | How to access your Cable-/DSL-Modem | +
-|  network    | [[doc:howto:configurecablemodem|Configure Motorola cable modem]] | How to configure your Motorola cable modem (DOCSIS)  | +
-|  network    | [[doc:howto:tc|Traffic Control]]  | Packet Scheduler, QoS, Traffic Shaping, Traffic Prioritizing  | +
-|  network    | [[doc:howto:netfilter|Netfilter]]  | Packet filter, firewall, iptables, ip6tables, ebtables, arptables  | +
-|  sys        | [[doc:howto:bwmon|Bandwidth Monitoring]]      | How to track bandwidth usage | +
-|  sys        | [[doc:howto:obtain.firmware|Obtain Firmware]]  | Four ways to obtain a Firmware-Image-File  | +
-|  network    | [[doc:howto:ddns.client|Dynamic DNS]]          | Create a domain name that points to your IP | +
-|  network    | [[doc:howto:dmz|Define a DMZ]] | Separate a switch port and make it a DMZ | +
-|  sys        | [[doc:howto:ead|EAD]] | Installing and using the Emergency Access Daemon | +
-|  sys        | [[doc:howto:extroot|Extroot]] | Using external storage as root filesystem | +
-|  sys        | [[doc:howto:kexec|Kexec]] | Boot a kernel from internal flash and then execute another kernel on external storage | +
-|  periphery  | [[doc:howto:usb.i2c-tiny-usb|I²C over USB]] | Using USB-I²C adapters on OpenWrt | +
-|  network    | [[doc:howto:nfs.server|NFS Server]] | Howto setup a Network File System (NFS) server on OpenWrt | +
-|            | [[doc:howto:pulseaudio|PulseAudio]] | Since trunk 2011-01 we can install PulseAudio  | +
-|            | [[inbox:netboot|NetBoot]] | NetBoot  | +
-| application | [[doc:howto:owncloud|ownCloud]] | Howto install ownCloud on OpenWRT | +
-|            | [[doc:howto:qemu|Qemu]] | Running OpenWrt in Qemu | +
-|  sys        | [[doc:howto:virtualbox|VirtualBox]] | Running OpenWrt in VirtualBox | +
-|  sys        | [[doc:howto:vmware|VMWare]] | Running OpenWrt in VMWare | +
-|  security  | [[doc:howto:wget-ssl-certs|wget Certificates]] | Installing SSL certificates for //wget// | +
-|  security  | [[doc:howto:http.mini-httpd|Mini-Httpd & SSL]] | How to get mini-httpd and SSL working | +
-|  sys        | [[doc:howto:hardware.button|Hardware Buttons]] | Make the Hardware Buttons toggle events | +
-|  sys        | [[doc:howto:xen|Xen]] | Running OpenWrt in Xen | +
-|  network    | [[doc:howto:udp_multicast|UDP multicast]] | IPTV / UDP multicast | +
-|  util      | [[doc:howto:boxbackup|BoxBackup]] | Running BoxBackup on OpenWrt | +
-|  external  | [[doc:howto:links.external.howtos]]  | Not everything can be in this wiki  | +
-|  network    | [[doc:howto:connect_by_l2tp]|Connect by L2TP]] | Connect to ISP using L2TP with Dual Access | +
-|  network    | [[doc:howto:port forwarding]|Port Forwarding]] | How to and examples of different cases of Port Forwarding | +
-|  network    | [[doc:howto:Kerberos]|Kerberos Server]] | How to setup a Kerberos Server for secure authentication | +
-|  other      | [[doc:howto:snippets|Snippets]] | Snippets and tweaks that didn't fit elsewhere |+
-==== UCI configuration ==== 
-OpenWrts central configuration is located in the ''/etc/config/'' directory. 
-{{section>doc:uci#configuration.files&noheader&nofooter&noeditbtn&firstseconly}} 
-===== Building =====+===== Building OpenWrt =====
These articles focus on compiling OpenWrt sources. These articles focus on compiling OpenWrt sources.
^ Page ^ Description ^ ^ Page ^ Description ^
 +| [[doc:howto:easy.build|Easy Build]] | Step by step instructions for building a OpenWRT firmware .bin for specific hardware |
| [[about:toolchain|OpenWrt Buildroot — About]] | About OpenWrt Buildroot  | | [[about:toolchain|OpenWrt Buildroot — About]] | About OpenWrt Buildroot  |
| [[doc:howto:buildroot.exigence|OpenWrt Buildroot – Installation]] | Setting up an OpenWrt build system | | [[doc:howto:buildroot.exigence|OpenWrt Buildroot – Installation]] | Setting up an OpenWrt build system |
Line 99: Line 78:
==== Build HOWTOs ==== ==== Build HOWTOs ====
 +
[[doc:howtobuild:start|Build-HowTos]] include doing things from scratch and then using the Build System to obtain an own firmware (see [[meta:template_howtobuild]]): [[doc:howtobuild:start|Build-HowTos]] include doing things from scratch and then using the Build System to obtain an own firmware (see [[meta:template_howtobuild]]):
Line 105: Line 85:
| [[doc:howtobuild:build.dockstar|Seagate Dockstar]] | Build the Seagate Dockstar 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:tl-mr3420.build|TP-Link TL-MR3420]] | Build the TP-Link TL-MR3420 firmware |
-| [[doc:howtobuild:extroot.howtobuild|ExtRoot]] | Build firmware with ExtRoot  |+| [[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:wireless-router-with-a-3g-dongle|3G-Dongle]] | Build firmware including UMTS-Modem support  |
| [[doc:howtobuild:single.package|single package]] | Compile and package only one single package  | | [[doc:howtobuild:single.package|single package]] | Compile and package only one single package  |
 +| [[doc:howtobuild:sheevaplug|SheevaPlug]] | Build the SheevaPlug firmware  |
 +
 +
 +
 +
 +
===== Developing ===== ===== Developing =====
Line 133: Line 119:
| [[doc:devel:config-scripting|Config scripting]] | Using UCI configuration files in shell scripts | | [[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:network-scripting|Network scripting]] | Network scripting and protocol handler API |
-| [[doc:devel:gdb|GNU Debugger]]    | Howto use the [[wp>GNU Debugger]]  | +| [[doc:devel:gdb|GNU Debugger]]    | How to use the [[wp>GNU Debugger]]  | 
-| [[doc:devel:Eclipse|Eclipse IDE]]    | Howto use the [[wp>Eclipse_%28software%29|Eclipse IDE]] including [[wp>GNU Debugger]]  |+| [[doc:devel:Eclipse|Eclipse IDE]]    | How to use the [[wp>Eclipse_%28software%29|Eclipse IDE]] including [[wp>GNU Debugger]]  |
Line 166: Line 152:
| [[doc:techref:externaldocumentation|External Documentation]] | Links to external documentation | | [[doc:techref:externaldocumentation|External Documentation]] | Links to external documentation |
-===== Frequently Asked Questions (FAQ) ===== +
-<html> +
-<DIV ALIGN="center">  +
-<table class="inline" style="width:auto;"> +
-  <tr> +
-    <td style="vertical-align:middle"> +
-      <a href="/doc/faq"> +
-      <img src="/_media/meta/48px-question.svg.png" alt="" style="float:left; margin-right:0.5em; border: 0px" /> +
-      <strong>New FAQ</strong> +
-      </a> +
-    </td> +
-    <td style="vertical-align:middle"> +
-      <a href="/oldwiki/faq"> +
-      <img src="/_media/meta/48px-help.svg.png" alt="" style="float:left; margin-right:0.5em; border: 0px" /> +
-      <strong>Old FAQ</strong> +
-      </a> +
-    </td> +
-  </tr> +
-</table> +
-</DIV> +
-</html>+

Back to top

doc/start.1349637181.txt.bz2 · Last modified: 2012/10/07 21:13 by jow