This reposistory builds the source image for download.openeew.com which is used as a secure download server to deliver firmware to OpenEEW sensors.
The OpenEEW Firmware that runs on the ESP32 based OpenEEW Sensor will activate itself via the OpenEEW Devicement Management orchestration process. The sensor firmware knows what version it is running and sends this information to the OpenEEW Device Management service endpoint. The endpoint responds with the latest version number of the firmware and the https URL where the latest version of the firmware can be downloaded. The ESP32 then determines if the firmware it is running is downlevel and, if necessary, will initiate an ESP32 over the air (OTA) upgrade using the esp_https_ota() API. That API downloads the new firmware binary from a https URL download server.
This repository contains the source image of that download server.
- the smallest, simplest Express https server
- the firmware binaries (typically sourced from OpenEEW Firmware Releases)
- the Dockerfile to build a container from this express server and firmware binaries
- the yaml file to deploy it to a IBM Cloud Container Service (IKS) kubernetes cluster that hosts the core components of openeew.com
This static-server.js module creates an HTTP web server and serves static content
from a specified directory on a specified port.
This express server is constructed from examples located at:
To execute this express server, git clone this repo. Review the package.json To start the local server.
npm install
node static-server.jsThe Dockerfile in this repo creates a container which runs the express server to serve the firmware binaries.
docker build -t openeew/openeew-download:v1 .
docker tag openeew/openeew-download:v1 us.icr.io/openeew-download/openeew-download:v1echo SERVER_PORT=8443>./env.list
docker rm openeew-download
docker run -it -p 8443:8443 --env-file env.list --name openeew-download openeew/openeew-download:v1
Use the download-v1.yaml file to deploy this container to IKS
To create the secret, you may need to add the base64 encoded SERVER_PORT to the Secret section of the yaml file
$ echo -n 8443 | base64
ODQ0Mw==ibmcloud login --sso
ibmcloud cr login
ibmcloud cr region-set us-south
ibmcloud target -g OpenEEW-Infra
ibmcloud ks cluster config --cluster <cluster-config>
ibmcloud cr namespace-add openeew-download
docker push us.icr.io/openeew-download/openeew-download:v1
kubectl apply -f download-v1.yaml --namespace default
Use your browser to download the Let's Encrypt server certificate for https://download.openeew.com Make certain you download the entire PEM chain. Test that you have a valid TLS SSL PEM file using this OpenSSL command.
openssl x509 -in openeew-com-chain.pem -noout -textEnjoy! Give us feedback if you have suggestions on how to improve this information.
The community welcomes your involvement and contributions to this project. Please read the OpenEEW contributing document for details on our code of conduct, and the process for submitting pull requests to the community.
This repository executes a GitHub Action that runs the prettier code formatter and dockerfilelint on every Push and Pull Request.
To install prettier and dockerfilelint in your local enviroment follow these instructions: install prettier, install dockerfilelint
The OpenEEW sensor is licensed under the Apache Software License, Version 2. Separate third party code objects invoked within this code pattern are licensed by their respective providers pursuant to their own separate licenses. Contributions are subject to the Developer Certificate of Origin, Version 1.1 (DCO) and the Apache Software License, Version 2.