Community OpenWrt How-To Guide

Welcome to the Community OpenWrt How-To Guide! This is a collection of recipes that will help you using the community.openwrt role in real world scenarios.

Most OpenWrt devices have a very small footprint and there is no space available to install Python. Based on this constraint, virtually all of the standard Ansible modules are not available.

It is a design rule of community.openwrt not to require Python, rather providing modules based on shell scripts (/bin/sh) instead.

Also by the nature of OpenWrt and its CLI-based uci tool, you need to be very familiar how this ecosystem works. Even the creation of a Wifi passwort or a simple forwarding rule can be challenging.

Below is a list of topics we intend to write How-To documents about. The ones that are not linked to another page are to be considered To-Be-Done (TBD), and they should be added incrementally. Contributions are welcome!

Initial Setup

  • Real Hardware

  • VM as a router for Proxmox or similar hypervisors

SSH Installation

  • Bootstrap

  • Initial SSH Key Installation

SSL Certificates

  • redirect http to https

  • acme support

  • Install existing ssl certificates

Wifi Setup

  • 2Ghz / 5Ghz

  • Passwords

  • Additional Guest Network + isolation

VPN

  • Wireguard Server

  • Wireguard Client

  • NordVPN or similar

  • Netbird

  • Tailscale

  • Tinc

Advanced networking

  • VLAN

  • VLAN per Hardware Port

  • Routing

  • Firewall, Port forwarding

Hardware

  • Configure the hardware button do do cool things

  • Configure the LEDs

Firmware Update

  • CLI / UI Tool installation

Backup/Restore

  • Backup

  • Restore

  • Crontab