don't set root password in docker image

add option to build from snapshot

.gitignore

@@ -1,3 +1,4 @@
+.vscode
 openwrt.conf
 .env
 *.tar.gz

.gitlab-ci.yml

@@ -1,5 +1,6 @@
 variables:
   CI_IMAGE: $DOCKER_HUB_USER/openwrt
+  CURRENT_STABLE_RELEASE: '19.07.4'
 
 build:
   image: docker:latest
@@ -7,12 +8,12 @@ build:
   services:
    - docker:dind
   variables:
-    TAG: 19.07.3-x86_64
+    TAG: $CURRENT_STABLE_RELEASE-x86_64
   before_script:
     - docker login -u $DOCKER_HUB_USER -p $DOCKER_HUB_TOKEN
   script:
     - cp openwrt.conf.example openwrt.conf
-    - sed -i -E "s@(BUILD_TAG=).+@\1$CI_IMAGE@" openwrt.conf
+    - sed -i -E "s@(IMAGE_TAG=).+@\1$CI_IMAGE@" openwrt.conf
     - apk add make
     - make build
     - docker tag $CI_IMAGE $CI_IMAGE:$TAG
@@ -38,7 +39,7 @@ build:
       done
   script:
     - cp openwrt.conf.example openwrt.conf
-    - sed -i -E "s@(BUILD_TAG=).+@\1$CI_IMAGE@" openwrt.conf
+    - sed -i -E "s@(IMAGE_TAG=).+@\1$CI_IMAGE@" openwrt.conf
     - wget -qO- $SRC_IMAGE | gzip -d > image.img
     - LOOP_ARGS="=/tmp/dev/loop0" ./build-rpi.sh
     - docker tag $CI_IMAGE $CI_IMAGE:$TAG
@@ -49,24 +50,25 @@ build:
 build-rpi2:
   extends: .build-rpi
   variables:
-    SRC_IMAGE: http://downloads.openwrt.org/releases/19.07.3/targets/brcm2708/bcm2709/openwrt-19.07.3-brcm2708-bcm2709-rpi-2-ext4-factory.img.gz
+    SRC_IMAGE: http://downloads.openwrt.org/releases/${CURRENT_STABLE_RELEASE}/targets/brcm2708/bcm2709/openwrt-${CURRENT_STABLE_RELEASE}-brcm2708-bcm2709-rpi-2-ext4-factory.img.gz
     TAG: rpi2
 
 build-rpi3:
   extends: .build-rpi
   variables:
-    SRC_IMAGE: https://downloads.openwrt.org/releases/19.07.3/targets/brcm2708/bcm2710/openwrt-19.07.3-brcm2708-bcm2710-rpi-3-ext4-factory.img.gz
+    SRC_IMAGE: https://downloads.openwrt.org/releases/${CURRENT_STABLE_RELEASE}/targets/brcm2708/bcm2710/openwrt-${CURRENT_STABLE_RELEASE}-brcm2708-bcm2710-rpi-3-ext4-factory.img.gz
     TAG: rpi3
 
 build-rpi4:
   extends: .build-rpi
   variables:
     SRC_IMAGE: https://downloads.openwrt.org/snapshots/targets/bcm27xx/bcm2711/openwrt-bcm27xx-bcm2711-rpi-4-ext4-factory.img.gz
+# no stable release for RPi 4 (yet), so we use snapshot
     VERSION: snapshot
     TAG: rpi4
 
-build-rpi-zero:
+build-rpi:
   extends: .build-rpi
   variables:
-    SRC_IMAGE: https://downloads.openwrt.org/releases/19.07.3/targets/brcm2708/bcm2708/openwrt-19.07.3-brcm2708-bcm2708-rpi-ext4-factory.img.gz
+    SRC_IMAGE: https://downloads.openwrt.org/releases/$CURRENT_STABLE_RELEASE/targets/brcm2708/bcm2708/openwrt-$CURRENT_STABLE_RELEASE-brcm2708-bcm2708-rpi-ext4-factory.img.gz
-    TAG: rpi-zero
+    TAG: rpi

Dockerfile

@@ -1,8 +1,5 @@
 FROM scratch
-ARG OPENWRT_SOURCE_VER
+ADD rootfs.tar.gz /
-ADD openwrt-${OPENWRT_SOURCE_VER}-x86-64-generic-rootfs.tar.gz /
-ARG ROOT_PW
-RUN echo -e "${ROOT_PW}\n${ROOT_PW}" | passwd
 RUN mkdir -p /var/lock
 RUN opkg remove dnsmasq && \
     opkg update && \
@@ -15,7 +12,7 @@ RUN opkg remove dnsmasq && \
       iperf3 \
       dnsmasq-full \
       iptables-mod-checksum
-RUN opkg list-upgradable | awk '{print $1}' | xargs opkg upgrade
+RUN opkg list-upgradable | awk '{print $1}' | xargs opkg upgrade || true
 RUN echo "iptables -A POSTROUTING -t mangle -p udp --dport 68 -j CHECKSUM --checksum-fill" >> /etc/firewall.user
 
 ARG ts

Dockerfile.rpi

@@ -1,10 +1,9 @@
 FROM scratch
 COPY . .
-ARG ROOT_PW
-RUN echo -e "${ROOT_PW}\n${ROOT_PW}" | passwd
 RUN mkdir -p /var/lock
 RUN opkg update && \
     opkg install \
+      luci \
       iperf3 \
       ip-full
 RUN  opkg list-upgradable | awk '{print $1}' | xargs opkg upgrade || true

LICENSE

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

Makefile

@@ -3,15 +3,21 @@
 include openwrt.conf
 export
 
-build:
+ifeq (${OPENWRT_SOURCE_VER}, snapshot)
-	wget -q https://downloads.openwrt.org/releases/${OPENWRT_SOURCE_VER}/targets/x86/64/openwrt-${OPENWRT_SOURCE_VER}-x86-64-generic-rootfs.tar.gz
+	ROOTFS_URL=https://downloads.openwrt.org/snapshots/targets/x86/64/openwrt-x86-64-rootfs.tar.gz
+else 
+	ROOTFS_URL=https://downloads.openwrt.org/releases/${OPENWRT_SOURCE_VER}/targets/x86/64/openwrt-${OPENWRT_SOURCE_VER}-x86-64-generic-rootfs.tar.gz
+endif
+
+rootfs.tar.gz:
+	wget ${ROOTFS_URL} -O rootfs.tar.gz
+
+build: rootfs.tar.gz
 	docker build \
-		--build-arg ROOT_PW \
-		--build-arg OPENWRT_SOURCE_VER \
 		--build-arg ts="$(shell date)" \
 		--build-arg version="${OPENWRT_SOURCE_VER}" \
-		-t ${BUILD_TAG} .
+		-t ${IMAGE_TAG} .
-	rm openwrt-${OPENWRT_SOURCE_VER}-x86-64-generic-rootfs.tar.gz
+	rm rootfs.tar.gz
 
 build-rpi:
 	./build-rpi.sh ${RPI_SOURCE_IMG}
@@ -20,6 +26,7 @@ run:
 	./run.sh
 
 clean:
+	docker stop ${CONTAINER} || true
 	docker rm ${CONTAINER} || true
 	docker network rm ${LAN_NAME} ${WAN_NAME} || true
 

README.md

@@ -1,5 +1,7 @@
 # OpenWrt in Docker
 
+[![pipeline status](https://gitlab.com/oofnik/docker-openwrt/badges/master/pipeline.svg)](https://gitlab.com/oofnik/docker-openwrt/-/commits/master)
+
 Inspired by other projects that run `hostapd` in a Docker container. This goes one step further and boots a full network OS intended for embedded devices called [OpenWrt](https://openwrt.org/), so you can manage all aspects of your network from a user-friendly web UI.
 
 For Raspberry Pi-specific instructions, see [Building on Raspberry Pi](docs/rpi.md).
@@ -24,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/<section>.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
 ```
@@ -62,7 +66,8 @@ This will delete the container and all associated Docker networks so you can sta
 
 In order for WLAN clients to see one another, OpenWrt bridges all interfaces in the LAN zone and sets hairpin mode (aka [reflective relay](https://lwn.net/Articles/347344/)) on the WLAN interface, meaning packets arriving on that interface can be 'reflected' back out through the same interface.
 
-`run.sh` tries to handle this, and prints a warning if it fails.
+`run.sh` tries to handle this if `WIFI_HAIRPIN` is set to true, and prints a warning if it fails.
+Hairpin mode may not be needed in all cases, but if you experience an issue where Wi-Fi clients are unable to see each other despite AP isolation being disabled, this may fix it.
 
 ### Network namespace
 

build-rpi.sh

@@ -31,10 +31,9 @@ mount_rootfs() {
 docker_build() {
 	echo "* building Docker image"
 	docker build \
-		--build-arg ROOT_PW="${ROOT_PW}" \
 		--build-arg ts="$(date)" \
 		--build-arg version="${VERSION:-$OPENWRT_SOURCE_VER}" \
-		-t ${BUILD_TAG} -f Dockerfile.rpi ${tmpdir}
+		-t ${IMAGE_TAG} -f Dockerfile.rpi ${tmpdir}
 }
 
 

docs/rpi.md

@@ -10,20 +10,22 @@ This has been tested on a Raspberry Pi Zero W running Raspbian Lite, but should
 
 | RPi version             | image:tag                |
 |------------------------|---------------------------|
-| Pi A / B / B+ / Zero W | `oofnik/openwrt:rpi-zero` |
+| Pi A / B / B+ / Zero W | `oofnik/openwrt:rpi`      |
 | Pi 2 B (all)           | `oofnik/openwrt:rpi2`     |
 | Pi 3 B / B+            | `oofnik/openwrt:rpi3`     |
 | Pi 4 / 4B              | `oofnik/openwrt:rpi4`     |
 
+**NOTE** that OpenWrt images for the Pi 3 and 4 are built for 64-bit kernels. If you are running Raspberry Pi OS 32-bit, you will be unable to run these images. It's perfectly fine to run the Pi Zero or Pi 2 images, however.
+
 ---
 ## Build 
 You can build the OpenWRT docker image on the Pi itself, or on your x86 PC with `qemu-user` and `binfmt-support` installed.
 
 First download and extract the OpenWRT factory image for your Pi. Refer to the [OpenWrt Table of Hardware](https://openwrt.org/toh/raspberry_pi_foundation/raspberry_pi) to choose the right image. Then run the `make` target as root (need access to mount loop filesystems).
 
-The variable `RPI_SOURCE_IMG` can be specified in openwrt.conf or on the command line:
+The variable `RPI_SOURCE_IMG` can be specified in openwrt.conf or on the command line (defaults to `image.img`):
 ```
-$ wget https://downloads.openwrt.org/releases/19.07.3/targets/brcm2708/bcm2708/openwrt-19.07.3-brcm2708-bcm2708-rpi-ext4-factory.img.gz -O image.img.gz
+$ wget https://downloads.openwrt.org/releases/19.07.4/targets/brcm2708/bcm2708/openwrt-19.07.4-brcm2708-bcm2708-rpi-ext4-factory.img.gz -O image.img.gz
 $ gzip -d image.img.gz
 $ sudo make build-rpi
 ```
@@ -34,10 +36,20 @@ $ docker save $BUILD_TAG | ssh <your_raspberry_pi_host> docker load
 ```
 
 ## IPv6
-By default Raspbian does not load the kernel module for IPv6 `iptables` on boot.
+By default Raspberry Pi OS does not load the kernel module for IPv6 `iptables` on boot.
 
 Run `sudo modprobe ip6_tables` to load it immediately.
 
 To persist on reboot, run
 
-    $ echo 'ip6_tables' | sudo tee /etc/modules-load.d/ip6-tables.conf
+    $ echo 'ip6_tables' | sudo tee /etc/modules-load.d/ip6-tables.conf
+
+## DHCP
+Raspberry Pi OS ships with a default `dhcpcd` configuration that assigns a DHCP address to every new interface added to the system including virtual ones.
+
+This is not necessarily what we want. Instead we would like to limit the interfaces `dhcpcd` watches to only the physical ones, i.e., interfaces `eth*` and `wl*`:
+
+```
+$ echo 'allowinterfaces eth* wl*' | sudo tee -a /etc/dhcpcd.conf
+$ sudo dhcpcd -n
+```

etc/config/dhcp.tpl

@@ -33,4 +33,4 @@ config odhcpd 'odhcpd'
         option maindhcp '0'
         option leasefile '/tmp/hosts/odhcpd'
         option leasetrigger '/usr/sbin/odhcpd-update'
-        option loglevel '4'
+        option loglevel '4'

etc/config/network.tpl

@@ -1,5 +1,5 @@
 config globals globals
-    option 'ula_prefix' "${LAN6_SUBNET}"
+    option 'ula_prefix' 'auto'
 
 config 'interface'    'loopback'
     option 'ifname'   'lo'
@@ -22,4 +22,4 @@ config 'interface'    'wan'
 
 config 'interface'    'wan6'
     option 'ifname'   'eth1'
-    option 'proto'    'dhcpv6'
+    option 'proto'    'dhcpv6'

etc/config/system.tpl

@@ -12,4 +12,4 @@ config timeserver 'ntp'
     list server '0.openwrt.pool.ntp.org'
     list server '1.openwrt.pool.ntp.org'
     list server '2.openwrt.pool.ntp.org'
-    list server '3.openwrt.pool.ntp.org'
+    list server '3.openwrt.pool.ntp.org'

etc/config/wireless.tpl

@@ -13,4 +13,4 @@ config 'wifi-iface'     "${WIFI_IFACE}"
     option 'ssid'       "${WIFI_SSID}"
     option 'encryption' "${WIFI_ENCRYPTION}"
     option 'key'        "${WIFI_KEY}"
-    option 'disassoc_low_ack' '0'
+    option 'disassoc_low_ack' '0'

monitoring/.env.example

@@ -1,5 +1,10 @@
+INFLUXDB_ADDRESS=192.168.16.4
 INFLUXDB_DB=collectd
 INFLUXDB_READ_USER=grafana
-INFLUXDB_READ_PASSWORD=supersecret
+INFLUXDB_READ_PASSWORD=supersecret1
+GF_ADDRESS=192.168.16.3
 GF_SECURITY_ADMIN_USER=admin
-GF_SECURITY_ADMIN_PASSWORD=changeme123
+GF_SECURITY_ADMIN_PASSWORD=supersecret2
+# enable these to serve Grafana from a sub-path, e.g., http://homelab.server/grafana
+# GF_SERVER_ROOT_URL=%(protocol)s://%(domain)s/grafana/
+# GF_SERVER_SERVE_FROM_SUB_PATH=true

monitoring/docker-compose.yaml

@@ -3,7 +3,8 @@ services:
   grafana:
     image: grafana/grafana:6.6.2
     networks:
-      - openwrt-lan
+      openwrt-lan:
+        ipv4_address: $GF_ADDRESS
     ports:
       - "3000:3000"
     env_file:
@@ -16,7 +17,8 @@ services:
   influxdb:
     image: influxdb:1.7
     networks:
-      - openwrt-lan
+      openwrt-lan:
+        ipv4_address: $INFLUXDB_ADDRESS
     env_file: 
       - .env
     volumes:

openwrt.conf.example

@@ -1,44 +1,58 @@
-### Sample OpenWRT config file ###
+### Sample OpenWrt config file ###
 
-## general
+## General
-# source image for Raspberry Pi build target
+# OpenWrt version
-SOURCE_IMG=openwrt-19.07.2-brcm2708-bcm2708-rpi-ext4-factory.img
+OPENWRT_SOURCE_VER=19.07.4
-# source for build (x86) target
+# image tag for pre-built Docker image, or if building locally
-OPENWRT_SOURCE_VER=19.07.3
+IMAGE_TAG=oofnik/openwrt
-# final tag for built Docker image
-BUILD_TAG=openwrt
 # container name 
 CONTAINER=openwrt_1
-ROOT_PW=changeme123
 
-# docker network settings
+## Docker network settings
-# wan
+# name of the WAN Docker network
 WAN_NAME=openwrt-wan
-# host interface which will provide the WAN link for OpenWRT
+# 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
+# Host interface which will provide the LAN link for OpenWrt.
-LAN_PARENT=eth1
+# Can be a physical interface or a VLAN of the primary interface if
+# operating without a second NIC.
+# 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, and
+# destroyed on shutdown.
+LAN_PARENT=eth0.10
+# Docker network driver for LAN interface, either 'bridge', 'macvlan', or 'ipvlan'.
+# Don't change this unless you have good reason.
+LAN_DRIVER=bridge
+# 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 settings
-WIFI_IFACE=wlp2s0
+WIFI_ENABLED=true
+WIFI_IFACE=wlan0
 WIFI_SSID=test123
 WIFI_ENCRYPTION=psk2
 WIFI_KEY=12345678
+# See README.md for explanation of this mode
+WIFI_HAIRPIN=false
+
+# Only one of the following sections at a time (5 / 2.4 GHz) are supported!
+## 5GHz 802.11ac (if your hw supports it)
 # WIFI_HW_MODE=11a
 # WIFI_HT_MODE=VHT80
 # WIFI_CHANNEL=36
+## 2.4 GHz 802.11g
 WIFI_HW_MODE=11g
 WIFI_HT_MODE=HT20
 WIFI_CHANNEL=6

run.sh

@@ -1,147 +1,208 @@
-#!/bin/bash
+#!/usr/bin/env bash
-# set -x 
+# set -x
 
 function _usage() {
-  echo "Could not find config file."
+	echo "Could not find config file."
-  echo "Usage: $0 [/path/to/openwrt.conf]"
+	echo "Usage: $0 [/path/to/openwrt.conf]"
-  exit 1
+	exit 1
 }
+
 SCRIPT_DIR=$(cd $(dirname $0) && pwd )
 DEFAULT_CONFIG_FILE=$SCRIPT_DIR/openwrt.conf
 CONFIG_FILE=${1:-$DEFAULT_CONFIG_FILE}
 source $CONFIG_FILE 2>/dev/null || { _usage; exit 1; }
 
 function _nmcli() {
-  type nmcli >/dev/null 2>&1
+	type nmcli >/dev/null 2>&1
-  if [[ $? -eq 0 ]]; then
+	if [[ $? -eq 0 ]]; then
-    echo "* setting interface '$WIFI_IFACE' to unmanaged"
+		echo "* setting interface '$WIFI_IFACE' to unmanaged"
-    nmcli dev set $WIFI_IFACE managed no
+		nmcli dev set $WIFI_IFACE managed no
-    nmcli radio wifi on
+		nmcli radio wifi on
-  fi
+	fi
 }
 
 function _get_phy_from_dev() {
-  if [[ -f /sys/class/net/$WIFI_IFACE/phy80211/name ]]; then
+	test $WIFI_ENABLED = 'true' || return
-    WIFI_PHY=$(cat /sys/class/net/$WIFI_IFACE/phy80211/name 2>/dev/null)
+	test -z $WIFI_PHY || return
-    echo "* got '$WIFI_PHY' for device '$WIFI_IFACE'"
+	if [[ -f /sys/class/net/$WIFI_IFACE/phy80211/name ]]; then
-  else
+		WIFI_PHY=$(cat /sys/class/net/$WIFI_IFACE/phy80211/name 2>/dev/null)
-    echo "$WIFI_IFACE is not a valid phy80211 device"
+		echo "* got '$WIFI_PHY' for device '$WIFI_IFACE'"
-    exit 1
+	else
-  fi
+		echo "$WIFI_IFACE is not a valid phy80211 device"
+		exit 1
+	fi
 }
 
 function _cleanup() {
-  echo -e "\n* cleaning up..."
+	echo -e "\n* cleaning up..."
-  echo "* stopping container"
+	echo "* stopping container"
-  docker stop $CONTAINER >/dev/null
+	docker stop $CONTAINER >/dev/null
-  echo "* cleaning up netns symlink"
+	echo "* cleaning up netns symlink"
-  sudo rm -rf /var/run/netns/$CONTAINER
+	sudo rm -rf /var/run/netns/$CONTAINER
-  echo "* removing host macvlan interface"
+	echo "* removing host $LAN_DRIVER interface"
-  sudo ip link del dev macvlan0
+	if [[ $LAN_DRIVER != "bridge" ]] ; then
-  echo -ne "* finished"
+		sudo ip link del dev $LAN_IFACE
+	elif [[ $LAN_PARENT =~ \. ]] ; then
+		sudo ip link del dev $LAN_PARENT
+	fi
+	echo -ne "* finished"
 }
 
 function _gen_config() {
-  echo "* generating network config"
+	echo "* generating network config"
-  set -a
+	set -a
-  source $CONFIG_FILE
+	_get_phy_from_dev
-  _get_phy_from_dev
+	source $CONFIG_FILE
-  for file in etc/config/*.tpl; do
+	for file in etc/config/*.tpl; do
-    envsubst <${file} >${file%.tpl}
+		envsubst <${file} >${file%.tpl}
-    docker cp ${file%.tpl} $CONTAINER:/${file%.tpl}
+		docker cp ${file%.tpl} $CONTAINER:/${file%.tpl}
-  done
+	done
-  set +a
+	set +a
 }
 
 function _init_network() {
-  echo "* setting up docker network"
+	echo "* setting up docker network"
-  docker network create --driver macvlan \
+	local LAN_ARGS
-    -o parent=$LAN_PARENT \
+	case $LAN_DRIVER in
-    --subnet $LAN_SUBNET \
+		bridge)
-    $LAN_NAME || exit 1
+			LAN_ARGS=""
+		;;
+		macvlan)
+			LAN_ARGS="-o parent=$LAN_PARENT"
+		;;
+		ipvlan)
+			LAN_ARGS="-o parent=$LAN_PARENT -o ipvlan_mode=l2"
+		;;
+		*)
+			echo "invalid choice for LAN network driver"
+			exit 1
+		;;
+	esac
+	docker network create --driver $LAN_DRIVER \
+		$LAN_ARGS \
+		--subnet $LAN_SUBNET \
+		$LAN_NAME || exit 1
 
-  docker network create --driver macvlan \
+	docker network create --driver macvlan \
-    -o parent=$WAN_PARENT \
+		-o parent=$WAN_PARENT \
-    $WAN_NAME || exit 1
+		$WAN_NAME || exit 1
 }
 
 function _set_hairpin() {
-  echo -n "* set hairpin mode on interface '$1'"
+	test $WIFI_HAIRPIN = 'true' || return
-  for i in {1..10}; do
+	echo -n "* set hairpin mode on interface '$1'"
-    echo -n '.'
+	for i in {1..10}; do
-    sudo ip netns exec $CONTAINER ip link set $WIFI_IFACE type bridge_slave hairpin on 2>/dev/null && { echo 'ok'; break; }
+		echo -n '.'
-    sleep 3
+		sudo ip netns exec $CONTAINER ip link set $WIFI_IFACE type bridge_slave hairpin on 2>/dev/null && { echo 'ok'; break; }
-  done
+		sleep 3
-  if [[ $i -ge 10 ]]; then
+	done
-    echo -e "\ncouldn't set hairpin mode, wifi clients will probably be unable to talk to each other"
+	if [[ $i -ge 10 ]]; then
-  fi
+		echo -e "\ncouldn't set hairpin mode, wifi clients will probably be unable to talk to each other"
+	fi
 }
 
 function _create_or_start_container() {
-  docker inspect $BUILD_TAG >/dev/null 2>&1 || { echo "no image '$BUILD_TAG' found, did you forget to run 'make build'?"; exit 1; }
+	if ! docker inspect $IMAGE_TAG >/dev/null 2>&1; then
-  
+		echo "no image '$IMAGE_TAG' found, did you forget to run 'make build'?"
-  if docker inspect $CONTAINER >/dev/null 2>&1; then
+		exit 1
-    echo "* starting container '$CONTAINER'"
-    docker start $CONTAINER
-  else
-    _init_network
-    echo "* creating container $CONTAINER"
-    docker create \
-      --network $LAN_NAME \
-      --cap-add NET_ADMIN \
-      --cap-add NET_RAW \
-      --hostname openwrt \
-      --dns 127.0.0.1 \
-      --ip $LAN_ADDR \
-      --sysctl net.netfilter.nf_conntrack_acct=1 \
-      --sysctl net.ipv6.conf.all.disable_ipv6=0 \
-      --sysctl net.ipv6.conf.all.forwarding=1 \
-      --name $CONTAINER $BUILD_TAG >/dev/null
-    docker network connect $WAN_NAME $CONTAINER
 
-    _gen_config
+	elif docker inspect $CONTAINER >/dev/null 2>&1; then
-    docker start $CONTAINER
+		echo "* starting container '$CONTAINER'"
-  fi
+		docker start $CONTAINER || exit 1
+
+	else
+		_init_network
+		echo "* creating container $CONTAINER"
+		docker create \
+			--network $LAN_NAME \
+			--cap-add NET_ADMIN \
+			--cap-add NET_RAW \
+			--hostname openwrt \
+			--dns 127.0.0.1 \
+			--ip $LAN_ADDR \
+			--sysctl net.netfilter.nf_conntrack_acct=1 \
+			--sysctl net.ipv6.conf.all.disable_ipv6=0 \
+			--sysctl net.ipv6.conf.all.forwarding=1 \
+			--name $CONTAINER $IMAGE_TAG >/dev/null
+		docker network connect $WAN_NAME $CONTAINER
+
+		_gen_config
+		docker start $CONTAINER
+	fi
 }
 
 function _reload_fw() {
-  echo "* reloading firewall rules"
+	echo "* reloading firewall rules"
-  docker exec -i $CONTAINER sh -c '
+	docker exec -i $CONTAINER sh -c '
-    for iptables in iptables ip6tables; do
+		for iptables in iptables ip6tables; do
-      for table in filter nat mangle; do
+			for table in filter nat mangle; do
-        $iptables -t $table -F
+				$iptables -t $table -F
-      done
+			done
-    done
+		done
-    /sbin/fw3 -q restart'
+		/sbin/fw3 -q restart'
+}
+
+function _prepare_wifi() {
+	test $WIFI_ENABLED = 'true' || return
+	test -z $WIFI_IFACE && _usage
+	_get_phy_from_dev
+	_nmcli
+	echo "* moving device $WIFI_PHY to docker network namespace"
+	sudo iw phy "$WIFI_PHY" set netns $pid
+	_set_hairpin $WIFI_IFACE
+}
+
+function _prepare_lan() {
+	case $LAN_DRIVER in
+		macvlan)
+			echo "* setting up host $LAN_DRIVER interface"
+			LAN_IFACE=macvlan0
+			sudo ip link add $LAN_IFACE link $LAN_PARENT type $LAN_DRIVER mode bridge
+			sudo ip link set $LAN_IFACE up
+			sudo ip route add $LAN_SUBNET dev $LAN_IFACE
+		;;
+		ipvlan)
+			echo "* setting up host $LAN_DRIVER interface"
+			LAN_IFACE=ipvlan0
+			sudo ip link add $LAN_IFACE link $LAN_PARENT type $LAN_DRIVER mode l2
+			sudo ip link set $LAN_IFACE up
+			sudo ip route add $LAN_SUBNET dev $LAN_IFACE
+		;;
+		bridge)
+			LAN_ID=$(docker network inspect $LAN_NAME -f "{{.Id}}")
+			LAN_IFACE=br-${LAN_ID:0:12}
+
+			# test if $LAN_PARENT is a VLAN of $WAN_PARENT, create it if it doesn't exist and add it to the bridge
+			local lan_array=(${LAN_PARENT//./ })
+			if [[ ${lan_array[0]} = $WAN_PARENT ]] && ! ip link show $LAN_PARENT >/dev/null 2>&1 ; then
+				sudo ip link add link ${lan_array[0]} name $LAN_PARENT type vlan id ${lan_array[1]}
+			fi
+			sudo ip link set $LAN_PARENT master $LAN_IFACE
+		;;
+		*)
+			echo "invalid network driver type, must be 'bridge' or 'macvlan'"
+			exit 1
+		;;
+	esac
+	echo "* getting address via DHCP"
+	sudo dhcpcd -q $LAN_IFACE
 }
 
 function main() {
-  test -z $WIFI_IFACE && _usage
+	cd "${SCRIPT_DIR}"
-  cd "${SCRIPT_DIR}"
+	_create_or_start_container
-  _get_phy_from_dev
-  _nmcli
-  _create_or_start_container
 
-  echo "* moving device $WIFI_PHY to docker network namespace"
+	pid=$(docker inspect -f '{{.State.Pid}}' $CONTAINER)
-  pid=$(docker inspect -f '{{.State.Pid}}' $CONTAINER)
-  sudo iw phy "$WIFI_PHY" set netns $pid
 
-  echo "* creating netns symlink '$CONTAINER'"
+	echo "* creating netns symlink '$CONTAINER'"
-  sudo mkdir -p /var/run/netns
+	sudo mkdir -p /var/run/netns
-  sudo ln -sf /proc/$pid/ns/net /var/run/netns/$CONTAINER
+	sudo ln -sf /proc/$pid/ns/net /var/run/netns/$CONTAINER
 
-  _set_hairpin $WIFI_IFACE
+	_prepare_wifi
+	_prepare_lan
 
-  echo "* setting up host macvlan interface"
+	_reload_fw
-  sudo ip link add macvlan0 link $LAN_PARENT type macvlan mode bridge
+	echo "* ready"
-  sudo ip link set macvlan0 up
-  sudo ip route add $LAN_SUBNET dev macvlan0
-
-  echo "* getting address via DHCP"
-  sudo dhcpcd -q macvlan0
-  
-  _reload_fw
-  echo "* ready"
 }
 
 main