Documentation

OpenWrt is a highly extensible GNU/Linux distribution for embedded devices (typically wireless routers). Unlike many other distributions for routers, OpenWrt is built from the ground up to be a full-featured, easily modifiable operating system for embedded devices. In practice, this means that you can have all the features you need with none of the bloat, powered by a modern Linux kernel.

Quick Start Guide User Guide Developer Guide
Start here if you are new to OpenWrt. Find out how to upgrade the firmware of your home router to use OpenWrt and make your network at home much better. Read more... Start here if you already have OpenWrt running on your router. OpenWrt has hundreds of optional packages that give you VPNs, VLANs, and other capabilities. Read more... Start here if you want to create custom builds of OpenWrt or contribute to its development. There are a large number of tools that make the development easy. Read more...
Hardware documentation Tech reference
A collection of articles about the hardware and devices the OpenWrt firmware runs on. Read more... Technical reference articles about OpenWrt components. Read more...

The three guides above (Quick Start, User, and Developer Guides) have links to virtually all the information about OpenWrt. You can also use the general Search function from any wiki page (see upper right corner), or use the search form below to search only in the documentation section of this wiki, or work your way through the complete listing of documentation pages shown below.

Search in the OpenWrt documentation:

Documentation pages by namespace

Documentation

Release goals

Firewall configuration

Firewall miscellaneous pages

netfilter and iptables

Alternate firewall builders

UPnP (Universal Plug and Play)

Audio support

Bluetooth in OpenWrt

LED manipulation and setup

Video support

Installation methods

Recovery methods

architecture

DSA Networking

IPv4

IPv6

Routing

Routing examples

Traffic shaping

VLAN (Virtual LAN)

WAN (Internet access)

Multi-WAN (Internet access through more than one modem/device)
WWAN (3G/4G/LTE and similar)

Wi-Fi configuration

Guest Wi-Fi
Mesh Wi-Fi
Wi-Fi network tools

Zero configuration network setup

...

examples

Automation, home automation and similar

Captive portals (splash pages for free or paid WiFi)

DC (Direct Connect file sharing)

DDNS (Dynamic Domain Name System)

DNS (Domain Name System)

Downloading and P2P file sharing

Email server and functionality

Media server (stream media to devices in the local network)

NAS (Network Attached Storage)

Network monitoring

NTP (time synchronization over Network Time Protocol)

Print server (printing over the network)

Proxy server

Control your device remotely without direct SSH access

Scanner server

SNMP (Simple Network Management Protocol)

SSH (Secure Shell remote access)

TLS encryption

Tor

UPS (Uninterruptible Power Supply)

VoIP (Voice over Internet Protocol)

VPN (Virtual Private Network)

Libreswan / IPsec
OpenConnect
OpenVPN
PPPoSSH
PPTP
SoftEther VPN
strongSwan / IPsec
Tinc
WireGuard

Wake on LAN (sending Ethernet messages to power up network devices)

Web servers

cfe

port.gpio

soc

soc.broadcom.bcm47xx
soc.broadcom.bcm63xx
soc.hisilicon.hi35xx

switch

This website uses cookies. By using the website, you agree with storing cookies on your computer. Also you acknowledge that you have read and understand our Privacy Policy. If you do not agree leave the website.More information about cookies
  • Last modified: 2023/04/20 18:58
  • by icecream