diff --git a/README.md b/README.md index 3c2dcb6..4db6b26 100644 --- a/README.md +++ b/README.md @@ -26,13 +26,15 @@ A searchable package list is available on [openwrt.org](https://openwrt.org/pack ## Configure -Initial configuration is performed using a config file, `openwrt.conf`. Values read from this file at runtime are used to generate OpenWrt format config files. +Initial configuration is performed using a config file, `openwrt.conf`. Values read from this file at runtime are used to generate OpenWrt format config files from templates in `etc/config/*.tpl`. -To add or change the base configuration, modify the config templates in `etc/config/
.tpl`. +You can use the included `openwrt.conf.example` as a baseline, which explains the values. -You can of course make persistent changes in the UI and download a backup of your full router configuration by navigating to System > Backup / Flash Firmware and clicking Backup. +It is also possible to make persistent changes in the UI and download a backup of your full router configuration by navigating to System > Backup / Flash Firmware and clicking Backup. ## Run + +Prepare your `openwrt.conf` file as explained above and execute the `make run` target: ``` $ make run ``` diff --git a/openwrt.conf.example b/openwrt.conf.example index 319b4ff..8f72cbe 100644 --- a/openwrt.conf.example +++ b/openwrt.conf.example @@ -2,37 +2,43 @@ ## general # source image for Raspberry Pi build target -SOURCE_IMG=openwrt-19.07.2-brcm2708-bcm2708-rpi-ext4-factory.img +SOURCE_IMG=openwrt-19.07.3-brcm2708-bcm2708-rpi-ext4-factory.img # source for build (x86) target OPENWRT_SOURCE_VER=19.07.3 -# final tag for built Docker image +# image tag for pre-built Docker image, or if building locally BUILD_TAG=openwrt # container name CONTAINER=openwrt_1 ROOT_PW=changeme123 -# docker network settings -# wan +## Docker network settings +# name of the WAN Docker network WAN_NAME=openwrt-wan # host interface which will provide the WAN link for OpenWRT WAN_PARENT=eth0 +# upstream DNS for OpenWrt UPSTREAM_DNS_SERVER=8.8.8.8 -# Static IP address configuration for OpenWRT LAN +# name of the LAN Docker network LAN_NAME=openwrt-lan -# host interface which will provide the LAN link for OpenWRT -LAN_PARENT=eth1 +# Host interface which will provide the LAN link for OpenWRT. +# Can be a physical interface or a VLAN of the primary interface. +# For example if WAN_PARENT is eth0, LAN_PARENT can be eth0.10 for +# VLAN 10. VLAN interface will be created if it doesn't exist. +LAN_PARENT=eth0.10 +# DNS search domain for LAN DHCP clients LAN_DOMAIN=home +# Subnet configuration for LAN network LAN_SUBNET=192.168.16.0/24 LAN6_SUBNET=fd99:1234::/48 # Set LAN_ADDR to something other than the first available address -# in the subnet - Docker will claim this address for the host +# in the subnet - Docker will claim this address for the host. LAN_ADDR=192.168.16.2 # openwrt doesn't accept CIDR notation; must match LAN_SUBNET LAN_NETMASK=255.255.255.0 # wifi settings -WIFI_IFACE=wlp2s0 +WIFI_IFACE=wlan0 WIFI_SSID=test123 WIFI_ENCRYPTION=psk2 WIFI_KEY=12345678