Switch to OpenWrt.

This switches the ChirpStack Gateway OS from Yocto to OpenWrt.
If you still want to use the Yocto recipes, then please switch
to the v4_yocto branch.

This splits the ChirpStack Gateway OS into the following repositories:

* chirpstack-gateway-os: scripts for setting up build environment
* chirpstack-openwrt-config: OpenWrt configuration files for the GW OS
* chirpstack-openwrt-feed: ChirpStack packages for OpenWrt

Author: brocaar

.gitignore

@@ -1,16 +1,3 @@
-# hidden files
-.*
-
-# logfiles
-*.log
-
-# VSCode
-/vscode-bitbake-build
-
-# builds
-/build
-/deploy
-/docs/public/
-/*.img
-/*.mender
-
+# OpenWrt
+/openwrt
+/dist

.gitmodules

@@ -0,0 +1,37 @@
+# Source:
+# https://openwrt.org/docs/guide-user/virtualization/obtain.firmware.docker
+
+FROM docker.io/debian:stable-slim
+
+ENV GCC_COLORS='error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01'
+WORKDIR /workdir
+
+RUN apt-get update && apt-get install --no-install-recommends --no-install-suggests --yes \
+    'build-essential' \
+    'ca-certificates' \
+    'clang' \
+    'flex' \
+    'bison' \
+    'g++' \
+    'gawk' \
+    'gcc-multilib' \
+    'g++-multilib' \
+    'gettext' \
+    'git' \
+    'libncurses5-dev' \
+    'libssl-dev' \
+    'python3-distutils' \
+    'rsync' \
+    'unzip' \
+    'zlib1g-dev' \
+    'file' \
+    'wget' \
+    'curl' \
+    'quilt' \
+    'nano' \
+  && \
+  rm -f -r '/var/lib/apt/' && \
+  rm -f -r '/var/cache/apt/' && \
+  useradd -m -s '/bin/bash' -U 'buildbot'
+
+USER buildbot

.templateconf

@@ -1,10 +1,20 @@
-.PHONY: submodules permissions
+.PHONY: clean init update devshell
 
-submodules:
-	git submodule init
-	git submodule update
+clean:
+	rm -rf openwrt
 
-permissions:
-	mkdir -p deploy
-	chmod 777 deploy
+init:
+	git clone --branch openwrt-23.05 https://github.com/openwrt/openwrt.git
+	git clone https://github.com/chirpstack/chirpstack-openwrt-config.git openwrt/env
+	cp feeds.conf.default openwrt/feeds.conf.default
+	docker-compose run --rm chirpstack-gateway-os scripts/feeds update -a
+	docker-compose run --rm chirpstack-gateway-os scripts/feeds install -a
 
+
+update:
+	cd openwrt && git pull
+	docker-compose run --rm chirpstack-gateway-os scripts/feeds update -a
+	docker-compose run --rm chirpstack-gateway-os scripts/feeds install -a
+
+devshell:
+	docker-compose run --rm chirpstack-gateway-os bash

Dockerfile

@@ -1,158 +1,116 @@
 # ChirpStack Gateway OS
 
-The ChirpStack Gateway OS is an embedded OS for LoRa gateways. It is part of the
-[ChirpStack](https://www.chirpstack.io/) open-source LoRaWAN Network Server stack.
+ChirpStack Gateway OS is an open-source [OpenWrt](https://openwrt.org/) based
+embedded OS for LoRa<sup>&reg;</sup> gateways. It provides a web-interface for
+configuration and contains pre-defined configuration options for common
+LoRa hardware to make it easy to setup a LoRa gateway and optionally a
+ChirpStack-based LoRaWAN<sup>&reg;</sup> Network Server.
 
-The goal of the ChirpStack Gateway OS is to provide firmware images that are easy
-to setup, maintain and customize.
+**Note:** If you are looking for the [Yocto](https://www.yoctoproject.org/)
+recipes of the previously Yocto based ChirpStack Gateway OS, please switch to
+the [v4_yocto](https://github.com/chirpstack/chirpstack-gateway-os/tree/v4_yocto)
+branch.
 
-## Images
+## Documentation and binaries
 
-### chirpstack-gateway-os-base
+Please refer to the [ChirpStack Gateway OS documentation](https://www.chirpstack.io/docs/chirpstack-gateway-os/)
+for documentation and pre-compiled images.
 
-An image providing the Semtech Packet Forwarder and ChirpStack Gateway Bridge.
+## Building from source
 
-Provides the following features:
+### Requirements
 
-* [Monit](https://mmonit.com/monit/) based service monitoring
-* [ChirpStack Concentratord](https://github.com/brocaar/chirpstack-concentratord/)
-* [ChirpStack Gateway Bridge](https://www.chirpstack.io/gateway-bridge/)
+Building ChirpStack Gateway OS requires:
 
-### chirpstack-gateway-os-full
+* [Docker](https://www.docker.com/)
 
-An image providing a complete LoRaWAN network-server running on the
-gateway.
+### Initialize
 
-Provides the following features:
+To initialize the [OpenWrt](https://openwrt.org/) build environment, run the
+following command:
 
-* [Monit](https://mmonit.com/monit/) based service monitoring
-* [ChirpStack Concentratord](https://github.com/brocaar/chirpstack-concentratord/)
-* [ChirpStack Gateway Bridge](https://www.chirpstack.io/gateway-bridge/)
-* [ChirpStack Network Server](https://www.chirpstack.io/network-server/)
-* [ChirpStack Application Server](https://www.chirpstack.io/application-server/)
-* [Mosquitto MQTT broker](http://mosquitto.org/)
-* [Redis](https://redis.io/)
-* [PostgreSQL](https://www.postgresql.org/)
-
-## Targets
-
-### Raspberry Pi
-
-* Raspberry Pi Zero W
-* Raspberry Pi 1
-* Raspberry Pi 3
-* Raspberry Pi 4
-
-#### Shields / kits
-
-* [IMST - iC880A](https://wireless-solutions.de/products/long-range-radio/ic880a.html)
-* [IMST - iC980A](http://www.imst.com/)
-* [IMST - Lite Gateway](https://wireless-solutions.de/products/long-range-radio/lora-lite-gateway.html)
-* [Pi Supply - LoRa Gateway Hat](https://uk.pi-supply.com/products/iot-lora-gateway-hat-for-raspberry-pi)
-* [RAK - RAK2245](https://store.rakwireless.com/products/rak2245-pi-hat)
-* [RAK - RAK2246 / RAK2246G](https://store.rakwireless.com/products/rak7246-lpwan-developer-gateway)
-* [RAK - RAK2287](https://store.rakwireless.com/products/rak2287-lpwan-gateway-concentrator-module)
-* [RAK - RAK831 Gateway Developer Kit](https://store.rakwireless.com/products/rak831-gateway-module?variant=22375114801252)
-* [RisingHF - RHF0M301 LoRaWAN IoT Discovery Kit](http://risinghf.com/#/product-details?product_id=9&lang=en)
-* [Sandbox Electronics - LoRaGo PORT](https://sandboxelectronics.com/?product=lorago-port-multi-channel-lorawan-gateway)
-* [Semtech - SX1302 CoreCell](https://www.semtech.com/products/wireless-rf/lora-gateways/sx1302cxxxgw1)
-* [Semtech - SX1280 2.4GHz gateway](https://www.semtech.com/products/wireless-rf/lora-gateways/sx1280zxxxxgw1)
-
-## Using
+```bash
+make init
+```
 
-### Login
+This will:
 
-The default username is `admin` with password `admin`.
+* Clone the OpenWrt code
+* Clone the [ChirpStack OpenWrt configuration](https://github.com/chirpstack/chirpstack-openwrt-config/)
+* Fetch all the OpenWrt feeds, including the [ChirpStack OpenWrt Feed](https://github.com/chirpstack/chirpstack-openwrt-feed)
 
-### Gateway configuration
+### Update
 
-Execute the following command as `admin` user:
+This step is not required after running `make init`, but allows you to update
+the OpenWrt source and feeds at a later point:
 
 ```bash
-sudo gateway-config
+make update
 ```
 
-## Building images
-
-A [Docker Compose](https://docs.docker.com/compose/) based build environment is provided for compiling the images.
+### Build
 
-**Note:** Compiling these images require a fair amount of CPU power, RAM and disk space.
-As a reference, the pre-compiled images are built using a 8 x Core i7 machine with 16GB RAM
-running Manjaro Linux with 200GB reserved for the build environment.
+For building the ChirpStack Gateway OS, you must enter the Docker-based
+development environment first:
 
-### Initial setup
-
-Run the following command to fetch the git submodules and setup directory
-permissions (to write back from the Docker container):
+```
+make devshell
+```
 
-```bash
-# update the submodules
-make submodules
+#### Switch configuration
 
-# setup permissions
-make permissions
-```
+Each target and image has its own configuration. To switch between
+configurations, you can use the `./scripts/env switch` command.
 
-Run the following command to set the `/build` folder permissions:
+Example to switch to the `base_raspberrypi_bcm27xx_bcm2709` configuration,
+you must run the following command:
 
 ```bash
-# on the host
-docker-compose run --rm busybox
-
-# within the container
-chown 999:999 /build
+./scripts/env switch base_raspberrypi_bcm27xx_bcm2709
 ```
 
-### Building
+Under the hood, this will switch the [chirpstack-openwrt-config](https://github.com/chirpstack/chirpstack-openwrt-config/branches)
+repository which has been cloned in the `env` directory branch and will setup
+all the symlinks.
 
-Run the following command to setup the build environment:
+To make sure there are no uncommitted changes, you can execute:
 
 ```bash
-# on the host
-docker-compose run --rm yocto bash
-
-# within the container
-
-# initialize the yocto / openembedded build environment
-source oe-init-build-env /build/ /chirpstack-gateway-os/bitbake/
+./scripts/env revert
+```
 
 
-# build the chirpstack-gateway-os-base image
-bitbake chirpstack-gateway-os-base
-```
+#### Configuration
 
-In case of error:
+To make configuration changes (e.g. add additional packages), you can execute:
 
 ```bash
-docker.credentials.errors.InitializationError: docker-credential-secretservice not installed or not available in PATH
+make menuconfig
 ```
 
-Make sure that the `golang-docker-credential-helpers` is installed. On `Ubuntu`
-you can install it with:
+As updates to OpenWrt packages can introduce new configuration options over
+time, you can run the following command to update the configuration:
 
 ```bash
-sudo apt install golang-docker-credential-helpers
+make defconfig
 ```
 
-#### Configuration
-
-By default, Raspberry Pi3 is configured as the target platform. You need to
-update the following configuration files to configure a different target:
+Please refer also to the [OpenWrt build system usage documentation](https://openwrt.org/docs/guide-developer/toolchain/use-buildsystem).
 
-* `/build/config/local.conf`
-* `/build/config/bblayers.conf`
+#### Building image
 
-## Good to know
+Once the configuration has been set, run the following command to build the
+ChirpStack Gateway OS image:
 
-### SD Card wearout
+```bash
+make
+```
 
-Although ChirpStack Network Server and ChirpStack Application Server try to minimize
-the number of database writes, there will be regular writes to the SD Card
-(PostgreSQL and Redis snapshots).
-According to [Is it true that a SD/MMC Card does wear levelling with its own controller?](https://electronics.stackexchange.com/questions/27619/is-it-true-that-a-sd-mmc-card-does-wear-levelling-with-its-own-controller)
-it might make a difference which SD Card brand you use.
+Note that this can take a couple of hours depending on the selected
+configuration and will require a significant amount of disk-space.
 
-### Versioning
+## Links
 
-The major version (major.minor.patch) of this project represents the major
-version of the provided ChirpStack Network Server stack.
+* [ChirpStack documentation](https://www.chirpstack.io/)
+* [chirpstack-openwrt-config](https://github.com/chirpstack/chirpstack-openwrt-config/) repository
+* [chirpstack-openwrt-feed](https://github.com/chirpstack/chirpstack-openwrt-feed) repository