OpenWrt  [OpenWrtDocs] [TitleIndex] [WordIndex]

OpenWrtDocs/Installing

OpenWrtDocs

Contents

  1. Supported hardware
  2. Choosing the right firmware
    1. TRX vs. BIN
  3. Installing OpenWrt
    1. via vendor supplied web interface
    2. via tftp
    3. via CFE
    4. via JTAG
    5. via the OpenWrt commandline

OpenWrt is free software, provided AS-IS under the terms of the GNU General Public License. We expect that you are knowledgeable about GNU/Linux and basic networking concepts, before you install OpenWrt on your router. Support may be provided on a voluntary basis by developers and fellow users, but support is not guaranteed.

Supported hardware

See TableOfHardware.

Choosing the right firmware

You can get the latest OpenWrt White Russian firmware images at: http://downloads.openwrt.org/whiterussian/newest/

Bugs in the firmware should be reported via the ticket system here.

White Russian ships in several variations, each with a slightly different set of packages installed by default. You're still free to add whatever packages you want, but this will save you from manually installing some common packages immediately after reflashing.

micro

bin

pptp

base-files

(./)

(./)

(./)

base-files-brcm

(./)

(./)

(./)

bridge

(./)

(./)

(./)

busybox

(./)

(./)

(./)

dnsmasq

(./)

(./)

(./)

dropbear

(./)

(./)

(./)

haserl

{X}

(./)

(./)

ipkg

/!\

(./)

(./)

iptables

(./)

(./)

(./)

iwlib

(./)

(./)

(./)

kmod-brcm-wl

(./)

(./)

(./)

kmod-diag

(./)

(./)

(./)

kmod-gre

{X}

{X}

(./)

kmod-pppoe

{X}

(./)

{X}

kmod-wlcompat

(./)

(./)

(./)

kmod-switch

(./)

(./)

(./)

mtd

(./)

(./)

(./)

nvram

(./)

(./)

(./)

ppp

{X}

(./)

(./)

ppp-mod-pppoe

{X}

(./)

{X}

pptp

{X}

{X}

(./)

uclibc

(./)

(./)

(./)

webif

{X}

(./)

(./)

wificonf

(./)

(./)

(./)

wireless-tools

{X}

(./)

(./)

* note: micro uses a compact version of ipkg which breaks some packages

TRX vs. BIN

The firmware files are shipped as either "trx" or "bin" files. The bin file is nothing more than a trx file with additional information added to make it compatible with the vendor's upgrade utilities. You should only use the bin files when you cannot use the trx files directly.

There are 3 trx files, found in the micro, pptp and bin directories explained above. Size restrictions aside, it doesn't matter which directory you pick, although if your device only has 2M of flash you will need to use micro.

After downloading the firmware image you should make sure that the file is not corrupt. This can be verified by comparing the md5sum from your downloaded image with the md5sum listed in the md5sums file found in the download directory. For win32 platforms use md5sums.exe for GNU/Linux systems use the md5sum command.

Installing OpenWrt

There are multiple ways to reflash the firmware, we will explain each method below. You can use any method, the end result will be the same. After reflashing, the device will automatically reboot into the new firmware.

If you are not happy with OpenWrt, you can always reinstall your original firmware. Please be sure you have it downloaded and saved on your PC.

/!\ We strongly suggest print a copy of OpenWrtDocs/Troubleshooting in case you have any trouble with the install

via vendor supplied web interface

This is the easiest method, Open your web browser and use the firmware upgrade page on your device to upload the OpenWrt firmware.

You should use HTTP rather than HTTPS for the firmware upgrade.

via tftp

If you're being extremely cautious or are attempting to reflash from a failed upgrade, you can use tftp to install the firmware. This method is explained in detail on the OpenWrtViaTftp page.

/!\ Note: some models have additional requirements, please refer to the CategoryModel page for documentation specific to your router model.

via CFE

If you already have the serial cable, you'll know how to do it, nevertheless... go OpenWrtDocs/Installing/CFE

via JTAG

It's not recommended to flash the kernel image via jtag, as it will take more than 2 hours, but it is possible OpenWrtDocs/Installing/JTAG

via the OpenWrt commandline

Reflashing OpenWrt will overwrite the filesystem, erasing all previous applications and data. You are strongly urged to back up any changes you may have made to the system. 

mtd -r write firmware.trx linux

For models low on memory (8MB), the firmware can be flashed directly from a web site.

/!\ Do not use this unless absolutely necessary. A dropped connection will result in a partially flashed router. You have been warned. 

wget http://www.somesite.com/firmware.trx -O - | mtd -e linux -r write - linux
2009-03-29 22:44