Documentation

User guide

Installation

• Back to original firmware
• FAQ after Installation of OpenWrt
• FAQ before installing OpenWrt
• Filesystem snapshot feature: /sbin/snapshot
• Flashing OpenWrt with Wi-Fi enabled on first boot
• Generic flashing over the Serial port
• Generic NOR backup
• How to restore ART partition
• Installing OpenWrt
• Installing OpenWrt over FTP (generic)
• Installing OpenWrt over XMODEM
• Installing OpenWrt via TFTP
• Installing OpenWrt with TFTP from a Linux computer
• OpenWrt on x86 hardware aka PC or Servers
• Upgrade from ar71xx to ath79
• Upgrading OpenWrt firmware using CLI
• Upgrading OpenWrt firmware using LuCI and CLI

Installation methods

• ADAM2 FTP
• Asus Firmware Restoration Tool
• brnboot web recovery
• CF card
• CFE TFTP + serial recovery
• CFE TFTP recovery
• CFE web recovery
• CLI generic
• D-Link Recovery GUI
• dataclouds
• EVA FTP
• fritzflash
• GUI generic
• GUI OEM
• JBoot web recovery
• JTAG
• Linksys TFTP
• Mikrotik TFTP
• Netboot
• nmrpflash
• RedBoot TFTP + serial recovery
• RedBoot TFTP recovery
• SD card
• see devicepage
• see forum
• see git-commit
• Serial
• Sunxi installation
• Sysupgrade
• Telnet
• TFTP generic
• TP-Link TFTP
• U-Boot TFTP + serial recovery
• U-Boot TFTP recovery
• U-Boot USB recovery
• U-Boot web recovery
• unknown
• x86 installation

Recovery methods

• ADAM2 FTP
• Asus Firmware Restoration Tool
• AVM recovery tool
• Breed web recovery
• brnboot web recovery
• CF card
• CFE TFTP + serial recovery
• CFE TFTP recovery
• CFE web recovery
• D-Link Recovery GUI
• EVA FTP
• GUI generic
• JBoot web recovery
• JTAG
• Linksys TFTP
• Mikrotik TFTP
• nmrpflash
• RedBoot TFTP + serial recovery
• RedBoot TFTP recovery
• SD card
• see devicepage
• see forum
• see git-commit
• TFTP generic
• TP-Link TFTP
• U-Boot TFTP + serial recovery
• U-Boot TFTP recovery
• U-Boot USB recovery
• U-Boot web recovery
• ubiquiti_tftp
• unknown

Documentation

User guide

Base system

• Basic Configuration
• Clarifying the term "Interface"
• Command-line interpreter
• DNS and DHCP configuration /etc/config/dhcp
• DNS and DHCP configuration examples
• DNS configuration
• Dnsmasq
• Dropbear configuration
• Dynamic DNS Client configuration
• Hotplug
• LED configuration /etc/config/system
• Managing services
• Network basics /etc/config/network
• Runtime Logging in OpenWrt
• Scheduling tasks
• System configuration /etc/config/system
• System configuration not handled by UCI
• The UCI system
• User Configuration
• Web Server Configuration

Documentation

User guide

LuCI Web Interface

• Accessing LuCI Web Interface Securely
• Dashboard
• How to get rid of LuCI HTTPS certificate warnings
• LuCI essentials
• LuCI on lighttpd
• LuCI themes
• luci-app-statistics
• Make luci-app-statistics graphs public
• Port Forwards
• Quick Setup
• Static IP
• Web Interface Overview

Documentation

User guide

Network

• Aliases
• Client Device - Connecting to an existing network
• DHCP configuration
• High availability
• Integrating an OpenWrt network device in your network
• IP rules (policy routing)
• IPv4/IPv6 Transition Technologies
• MAP IPv4-over-IPv6 encapsulation
• MultipathTCP and OpenWrt
• OpenWrt as router device
• Particularities of Single-Port Devices
• Routed Client
• Router vs Switch vs Gateway and why NAT influences this decision
• Routing
• Routing Example: Bridged DMZ
• Routing Example: GRE
• Routing Example: OpenVPN
• Static configuration
• Static Routes
• Tunneling interface protocols
• UCI networking options cheatsheet

IPv4

• Routing Example: IPv4

IPv6

• 6to4 IPV6 encapsulation example
• How to use OpenWrt behind a Freebox Crystal with IPv6 bridge
• How to use OpenWrt behind a Freebox with IPv6 delegation
• IPv6 DNS
• IPv6 Essentials
• IPv6 ISPs
• IPv6 on softwire
• IPv6 overview
• IPv6 theory
• NAT6 and IPv6 masquerading
• Routing example with IPv6
• Setting up an IPv6 tunnel using LuCI
• WIDE-DHCPv6 client configuration

Traffic Shaping

• Brain Fuck Scheduler
• CHOKe
• Class Based Queueing
• CoDel
• Deficit Round Robin
• Example1: Traffic Prioritizing with PRIO
• Example2: plain simple bandwidth sharing (aka traffic shaping) with HTB
• Example3: traffic shaping and prioriziting for multiple users with HFSC
• Example4: HFSC + FQ_CODEL + FLOW classifier
• Example5: Traffic Prioritizing with HTB and MAC filtering
• Fair Queue CoDel
• Hierarchical Fair Service Curve
• Hierarchy Token Bucket
• Linux Packet Scheduling
• Netem (Network Emulator)
• QoS (aka Network Traffic Control)
• QoS configuration /etc/config/qos
• Random Early Detection
• SQM (aka Smart Queue Management)
• SQM configuration /etc/config/sqm
• SQM Details
• Stochastic Fairness Queueing
• Token Bucket Filter

VLAN (aka Virtual LAN)

• Extending the router ports with a managed switch with VLANs
• Splitting VLANs
• Switch Documentation
• VLAN

WAN (aka Internet access)

• Accessing your modem
• Bridge Mode
• Connect to ISP using L2TP with dual access
• EasyCwmp (CPE WAN Management Protocol daemon)
• How to configure Motorola cable modems (DOCSIS)
• Internet Connection
• IPTV / UDP multicast
• ISP Configurations
• Poor Man's Bridge Mode
• Scripts to get information from modems
• Simple WAN Failover with 3G/LTE WWAN - Using a second router in the same LAN
• Smartphone USB reverse tethering with OpenWrt
• Smartphone USB tethering
• TR-069 / CWMP
• Using multiple public IPs on wan interface
• Using multiple wan with multiple routers
• WAN interface protocols
• X Play

MultiWAN (aka accessing the internet through more than one modem/device)

• Multiwan
• multiwan: Connection to spare internet provider
• mwan3 (Load balancing/failover with multiple WAN interfaces)

WWAN aka 3G/4G/LTE and similar

• Dealing with monthly GB quotas
• How To send AT commands to device
• How To use LTE modem in QMI mode for WAN connection
• ModemManager
• USB mode switch
• Use 3g/UMTS USB Dongle for WAN connection
• Use cdc_ether driver based dongles for WAN connection
• Use NCM USB Dongle for WAN connection
• Use RNDIS USB Dongle for WAN connection

Wi-Fi configuration

• Atheros and MAC80211 WDS to implement a wireless network bridge (wireless repeater)
• Bridged AP
• Configure A(ccess) P(oint or 'hotspot') + STA(tion or 'client')
• Configure Wi-Fi encryption
• Connect to client Wi-Fi network
• Country code for Wi-Fi operation
• Exceeding transmit power limits
• FreeRADIUS
• Introduction to 802.1x
• Routed AP
• RSN preauthentication
• Setting up Wi-Fi repeaters with multiple SSIDs with separated private, tor and guest network
• Table of capabilities for wireless chipsets
• USB 3.0 and Wi-Fi problems
• Wi-Fi /etc/config/wireless
• Wi-Fi extender / repeater / bridge configuration
• Wi-Fi on/off buttons
• Wi-Fi toggle
• Wide area Wi-Fi coverage
• Wireless Access Point / Dumb Access Point / Dumb AP
• Wireless overview
• wpa_supplicant

Guest Wi-Fi

• Guest Wi-Fi basics
• Guest Wi-Fi extras
• Guest Wi-Fi on a wireless AP using LuCI
• Guest Wi-Fi using CLI
• Guest Wi-Fi using LuCI

Mesh Wi-Fi

• 802.11s based wireless mesh network
• B.A.T.M.A.N. / batman-adv
• OLSR Mesh

Wi-Fi network tools

• Aircrack
• Horst
• Kismet
• Wireless Utilities

Zero configuration network setup

• The Homenet Control Protocol (HNCP)
• Zero configuration networking in OpenWrt

Documentation

User guide

Firewall Documentation

• Firewall and Network Interfaces
• Firewall components
• Firewall configuration /etc/config/firewall
• Firewall Overview

fw3 Configurations

• Bridge firewall
• DNS hijacking
• DNS hijacking using LuCI
• DNS-based firewall with IP sets
• Firewall usage guide
• fw3 DMZ Configuration Using VLANs
• fw3 IPset configuration examples
• fw3 IPv4 configuration examples
• fw3 IPv6 configuration examples
• fw3 Logging Rejected Packets
• fw3 NAT Configurations
• fw3 Port Forwarding
• fw3 Reference Network Topology
• Parental controls

Firewall Miscellaneous Items

• How to capture, filter and inspect packets using tcpdump or wireshark tools
• nftables

netfilter and iptables

• Logging Forwarded Packets in OpenWrt
• netfilter Configuration Examples
• Netfilter In OpenWrt
• Netfilter Management

Alternate Firewall Builders

• Firewall Builder: Essence Reloaded
• Firewall Builder: fwBuilder GUI
• Firewall Builder: Shell scripts
• Firewall Builder: Shorewall-lite

UPnP (aka Universal Plug and Play)

• miniupnpd
• Universal Plug'n'Play and NAT-PMP on OpenWrt

Documentation

User guide

Advanced Configuration

• Auto Wake On LAN script for hosts
• Configuring kexec
• Connect an Arduino to OpenWrt
• Mining Bitcoins with OpenWrt
• NTP
• SDR
• Send SMS from Shell
• Send SMS or Email using 3G/GSM modem
• Sharing raw NMEA GPS data over the network with multiple clients
• Smartphone USB tethering
• Snippets
• Steam Caching using Nginx

Documentation

User guide

Installing additional software

• Beginners guide to building your own firmware
• Create new users and groups for applications or system services
• Extroot configuration
• Managing packages
• Opkg Package Manager
• Saving firmware space
• Show available package upgrades after SSH login
• Smartmontools
• Using the Image Builder

Documentation

User guide

Hardware features and modifications

• Add a buzzer (beeper) to the router
• Attach functions to a push button
• Change UART serial port speed (baud rate) on OpenWrt
• Debrick ath79 using JTAG
• Devolo Streaming Radio
• ESP8266 serial bridge
• Hardware watchdog
• How to turnoff JTAG to free GPIO (only on ath79 processors)
• How to turnoff UART to free GPIO (only on ath79 processors)
• How to use I²C over USB
• LIRC audio_alsa
• LIRC GPIO blaster
• LIRC GPIO receiver / blaster
• MMC/SD card over GPIO howto
• PirateBox & LibraryBox
• PWM emulation with GPIO
• SIP daemon for Lantiq devices with owsip
• Terminate UART Console
• Turning USB power on and off
• USB Guest configuration

Audio support

• PulseAudio
• USB Audio Support

Bluetooth in OpenWrt

• Bluetooth Audio
• IPv6 over Bluetooth Smart (Low Energy)
• USB Bluetooth support

Led manipulation and setup

• Signal strength Led Meter
• Use leds to show signal strength with rssileds

Video support

• USB Video Support
• Webcam with the Linux UVC driver

Documentation

User guide

Storage functions

• Disk Encryption
• Filesystems
• Fstab Configuration
• hd-idle Configuration
• Installing and troubleshooting USB Drivers
• mountd Configuration
• Using storage devices
• Writable NTFS

Documentation

User guide

Additional Services

• Ad blocking
• AOE (aka (s)ATA over Ethernet) with vblade
• Babel routing protocol (babeld)
• BoxBackup
• BoxBackup Server Configuration (bbstored)
• CHROOT
• Gitolite user-restricted git hosting
• Kerberos Server HowTo
• Prosody XMPP Server (open messaging protocol)
• PXE-Boot network boot server
• Python
• Random generator
• Single Packet Authorization with Fwknop
• SNORT
• USB over IP tunnel

Automation, home automation and similar

• Crelay
• Domoticz on OpenWrt
• FHEM on OpenWrt
• pywws Python Weather Station HowTo
• Weather station control with WeeWX

Captive Portals (aka splash pages for an open/paid Wi-Fi hotspot)

• CoovaChilli captive portal
• Nodogsplash (Outdated document)
• NoDogSplash Captive Portal
• OpenNDS Captive Portal
• WiFiDog captive portal

Direct Connect

• DC overview
• Direct Connect and Advanced Direct Connect

DDNS (aka Dynamic Domain Name Server)

• DDNS Client
• DDNS Client DuckDNS
• DDNS Client Hurricane Electric

DNS (aka Domain Name System)

• Bind
• DNS over HTTPS with Dnsmasq and https-dns-proxy
• DNS over TLS with Dnsmasq and Stubby
• DNS over TLS with Unbound
• DNSCrypt with Dnsmasq and dnscrypt-proxy
• DNSCrypt with Dnsmasq and dnscrypt-proxy2
• dnscrypt-proxy
• ipset-dns
• Stubby
• Tinydns
• Unbound

Downloading and P2P Filesharing

• BitTorrent
• NZBGet
• Transmission configuration

Email server and functionality

• SMTP clients
• XMail mail server

Media Server (aka stream media to devices in your local network)

• DLNA Media Server
• iTunes server (forked-daapd)
• MiniDLNA
• Rygel UPnP media server
• uShare configuration

NAS (aka Network Attached Storage)

• AFP Netatalk share configuration (aka Apple Time Machine).
• CIFS Client
• FTP servers
• iSCSI
• Network File System (NFS)
• NFS client
• NFS Network File System share configuration (aka Linux/Unix file sharing).
• ownCloud or NextCloud
• Pure-FTPd Configuration
• RemoteFS Client
• RemoteFS Server
• Samba
• Samba (smb)
• SFTP server
• Share USB hard-drive with Samba using LuCI
• SMB Samba share overview (aka Windows file sharing).

Network Monitoring

• Bandwidth monitoring through scripts
• Bandwidth Monitoring with bwmon
• Bandwidthd
• bandwith monitor with wrtbwmon
• collectd.rrdtool
• Darkstat
• Network Traffic Monitor with vnStat
• ZABBIX network monitoring

NTP (aka network time synchronization)

• NTP client / NTP server
• Ntpclient Configuration
• Stratum 1 NTP server using USB GPS

Print Server (aka printing over the network)

• CUPS Print Server
• p910nd
• p910nd Print Server
• p910nd Printer Server
• Printing over SSH

Proxy server

• Privoxy
• Proxy server overview
• Shadowsocks
• Squid
• Tinyproxy
• udpxy
• VNC Repeater
• ZNC IRC network bouncer

Control your device remotely without direct ssh access

• daloRADIUS management system
• Ostiary Client (run a fixed set of commands remotely)
• Ostiary Daemon (run a fixed set of commands remotely)
• Port knocking server knockd

Scanner server

• saned scanner server

SNMP (aka Simple Network Management Protocol)

• Minimal SNMP Daemon (mini_snmpd) configuration
• SNMPD
• snmpd

SSH (aka Secure Shell Remote Access)

• Autossh
• SSH FileSystem
• SSH tunnel
• SSHFS client

Tor

• Tor client
• Tor extras

UPS (aka Uninterruptible Power Supply)

• APC BackUps ES-500 - Linksys EA3500 - LuCI graphs
• APC SmartUps SU-700 - Linksys EA3500 - LuCI graphs
• How to add data from a TP9605BT multimeter to apcupsd rrd and graphs.
• NUT (Network UPS Tools)

VoIP (aka Voice over IP protocol)

• Asterisk
• chan-lantiq for Asterisk
• FreeSWITCH on OpenWrt intro
• Siproxd on OpenWrt intro
• µMurmur

VPN (aka Virtual Private Network)

• pppossh
• Pseudowire
• Tinc
• VPN server and client
• VPNC client

Libreswan / IPsec

• IPsec site-to-site
• Libreswan L2TP/IPsec

OpenConnect

• OpenConnect client
• OpenConnect server

OpenVPN

• Automated script on PC
• Configure Astrill OpenVPN on OpenWrt
• Dual WAN VPN
• How to Setup Multiple OpenVPN Server to Different VLANs
• OpenVPN client
• OpenVPN client using LuCI
• OpenVPN extras
• OpenVPN performance
• OpenVPN server

PPTP

• PPTP client
• PPTP extras
• PPTP server

strongSwan / IPsec

• IPsec basics
• IPsec Firewall
• IPsec Legacy IKEv1 Configuration
• IPsec Modern IKEv2 Road-Warrior Configuration
• IPsec Performance
• IPsec Site-to-Site
• IPsec With Overlapping Subnets
• strongSwan IPsec Configuration via UCI

WireGuard

• WireGuard client
• WireGuard extras
• WireGuard peers
• WireGuard performance
• WireGuard server

Wake On Lan (aka send messages to power up devices connected to ethernet)

• Etherwake configuration
• Wake on LAN configuration

Web servers

• Apache HTTP Server
• BusyBox HTTP Daemon (httpd) webserver
• Hiawatha webserver
• Lighttpd webserver
• mini-httpd webserver
• Netcat as Webserver
• Nginx webserver
• PHP
• Set up a LAMP webserver stack
• uHTTPd Web Server Configuration
• uHTTPd webserver
• Using OpenWrt/LEDE to build a LAMP/WordPress dev server on a travel router

Documentation

User guide

Troubleshooting

• Backup and restore
• Failsafe Mode, Factory Reset, and Recovery Mode
• For Developers: Activating EAD (Emergency Access Daemon) Before Running into Problems
• OpenWrt Debricking Guide
• Rescue from failed firmware upgrade
• Resetting the root password
• Setting up a TFTP server for TFTP Recovery/Install

Documentation

User guide

Virtualization

• Docker OpenWrt Image Generation
• Metarouter Virtualization on Mikrotik RouterBoard
• OpenWrt as a Docker Image
• OpenWrt as a Xen DomU guest
• OpenWrt as Docker container host
• OpenWrt as DomU in Debian Xen4 in a private network
• OpenWrt as QEMU/KVM host server
• OpenWrt in LXC containers
• OpenWrt in QEMU
• OpenWrt on VirtualBox HowTo
• OpenWrt on VMware HowTo
• OpenWrt running as metarouter on mikrotik routerOS
• VirtualBox Advanced

Documentation

User guide

Security

• Dropbear key-based authentication
• Hardening of your OpenWrt device
• Key Generation
• OpenWrt security features
• OpenWrt/LEDE Public Keys
• Regaining access to an OpenWrt device in client mode
• Release Signing
• Secure your router's access
• Security Guide for the Paranoid
• Serial console password