Doc updates, riscv static libgcc_s, changelog

Author: SuperioOne

Diff for: CHANGELOG

@@ -1,3 +1,29 @@
+# v0.3.0 - July 17, 2024
+-----------------------------------
+
+## Added
+
+- Brotli compression support.
+- UPS beeper, UPS status and server connectivity indicators.
+- --poll-interval and partial update support to get critical variable updates more often.
+- Support for ARM-v6, ARM-v7, RISC-v64 and x86-64 micro-architecture levels.
+- Self-contained binary releases for non-container environments.
+
+## Changed
+
+- Container base image changed to busybox, image sizes are now ~5MiB smaller than 0.2.1.
+- Security updates for dependencies.
+- Switched to apexcharts.
+
+## Fixed
+
+- Gauge colors change correctly when theme changes.
+- Better theme initialization to prevent flashbang effect when page loaded.
+
+## Deleted
+
+- Lofi theme.
+
 # v0.2.1 - April 08, 2024
 -----------------------------------
 

Diff for: Makefile

@@ -91,7 +91,7 @@ $(call fn_output_path,x86-64-v4-musl) &: $(PROJECT_SRCS)
 	@install -D $(call fn_target_path,x86_64-unknown-linux-musl/release) \
 		$(call fn_output_path,x86-64-v4-musl)
 
-# ARMv8
+# ARM64v8
 
 .PHONY: build-aarch64-musl
 build-aarch64-musl: $(call fn_output_path,aarch64-musl) build-client
@@ -149,7 +149,7 @@ build-riscv64gc-gnu: $(call fn_output_path,riscv64gc-gnu) build-client
 $(call fn_output_path,riscv64gc-gnu) &: $(PROJECT_SRCS)
 	@echo "Building for riscv64gc-unknown-linux-gnu"
 	@cd ./server && \
-		export RUSTFLAGS="-Clinker=riscv64-linux-gnu-gcc" && \
+		export RUSTFLAGS="-Clinker=riscv64-linux-gnu-gcc -Ctarget-feature=+crt-static" && \
 		cargo build --target=riscv64gc-unknown-linux-gnu --release
 	@install -D $(call fn_target_path,riscv64gc-unknown-linux-gnu/release) \
 		$(call fn_output_path,riscv64gc-gnu)
@@ -214,19 +214,19 @@ generate-dockerfiles:
 	@echo "riscv64.Dockerfile"
 	@sed -e 's/{BIN_DIR}/riscv64gc-gnu/g' \
 		-e 's/{PLATFORM}/linux\/riscv64/g' \
-		-e 's/{BUSYBOX_LABEL}/stable-glibc/g' \
+		-e 's/{BUSYBOX_LABEL}/stable-musl/g' \
 		"$(DOCKER_TEMPLATE)" > ./containers/riscv64.Dockerfile
 	@echo "Generating annotation.conf"
 	@CARGO_MANIFEST=$$(cargo read-manifest --manifest-path ./server/Cargo.toml); \
 	echo "VERSION=\"$$(jq -r ".version" <<< "$${CARGO_MANIFEST}")\"" > ./containers/annotation.conf; \
-	echo "HOME_URL=\"$$(jq -r ".homepage" <<< "$${CARGO_MANIFEST}")\"">> ./containers/annotation.conf; \
-	echo "NAME=\"$$(jq -r ".name" <<< "$${CARGO_MANIFEST}")\"">> ./containers/annotation.conf; \
-	echo "LICENSES=\"$$(jq -r ".license" <<< "$${CARGO_MANIFEST}")\"">> ./containers/annotation.conf; \
-	echo "AUTHORS=\"$$(jq -r '.authors | join(" ")' <<< "$${CARGO_MANIFEST}")\"">> ./containers/annotation.conf; \
-	echo "DOCUMENTATION=\"$$(jq -r ".documentation" <<< "$${CARGO_MANIFEST}")\"">> ./containers/annotation.conf; \
-	echo "SOURCE=\"$$(jq -r ".repository" <<< "$${CARGO_MANIFEST}")\"">> ./containers/annotation.conf; \
-	echo "DESCRIPTION=\"$$(jq -r ".description" <<< "$${CARGO_MANIFEST}")\"">> ./containers/annotation.conf; \
-	echo "REVISION=\"$$(git rev-parse --verify HEAD)\"">> ./containers/annotation.conf;
+	echo "HOME_URL=\"$$(jq -r ".homepage" <<< "$${CARGO_MANIFEST}")\"" >> ./containers/annotation.conf; \
+	echo "NAME=\"$$(jq -r ".name" <<< "$${CARGO_MANIFEST}")\"" >> ./containers/annotation.conf; \
+	echo "LICENSES=\"$$(jq -r ".license" <<< "$${CARGO_MANIFEST}")\"" >> ./containers/annotation.conf; \
+	echo "AUTHORS=\"$$(jq -r '.authors | join(" ")' <<< "$${CARGO_MANIFEST}")\"" >> ./containers/annotation.conf; \
+	echo "DOCUMENTATION=\"$$(jq -r ".documentation" <<< "$${CARGO_MANIFEST}")\"" >> ./containers/annotation.conf; \
+	echo "SOURCE=\"$$(jq -r ".repository" <<< "$${CARGO_MANIFEST}")\"" >> ./containers/annotation.conf; \
+	echo "DESCRIPTION=\"$$(jq -r ".description" <<< "$${CARGO_MANIFEST}")\"" >> ./containers/annotation.conf; \
+	echo "REVISION=\"$$(git rev-parse --verify HEAD)\"" >> ./containers/annotation.conf;
 
 .PHONY: clean
 clean:

Diff for: README.md

@@ -1,60 +1,71 @@
 # NUT Web GUI
 
-[![version:0.2.1](https://img.shields.io/badge/version-0.2.1-red)](https://github.com/SuperioOne/nut_webgui/releases/tag/v0.2.1)
-[![version:0.2.1](https://img.shields.io/badge/linux/amd64-0.2.1-green)](https://github.com/SuperioOne/nut_webgui/pkgs/container/nut_webgui)
-[![version:0.2.1](https://img.shields.io/badge/linux/arm64-0.2.1-green)](https://github.com/SuperioOne/nut_webgui/pkgs/container/nut_webgui)
-
-Web-based simple interface for [Network UPS Tools](https://networkupstools.org/).
+Light weight web interface for [Network UPS Tools](https://networkupstools.org/).
 
 **Quickstart:**
 
 ```shell
-docker run --rm -e UPSD_ADDR=10.0.0.1 -e UPSD_USER=test -e UPSD_PASS=strongpass -p 9000:9000 ghcr.io/superioone/nut_webgui:latest   
+docker run -e UPSD_ADDR=10.0.0.1 -e UPSD_USER=test -e UPSD_PASS=strongpass -p 9000:9000 ghcr.io/superioone/nut_webgui:latest
 ```
 
 ## Features
 
-- Monitoring UPS variables with auto refresh.
-- List supported commands by UPS and allows INSTCMD calls from GUI.
-- Lightweight and small.
+- Monitors UPS variables with auto refresh.
+- Supports INSTCMD calls from GUI.
+- 🥔 Potato PC friendly. Small footprint on both resource usage and disk size.
+- Basic JSON API.
+- Supports RISC-V and older ARM devices.
 
 > In order to run `INSTCMD`, make sure the configured user has proper instcmds granted at `upsd.users`. See
 > man([upsd.users](https://networkupstools.org/docs/man/upsd.users.html)).
 
+## CPU architecture support
+
+| Arch         | Test Hardware           | Notes                                                                                    |
+|--------------|-------------------------|------------------------------------------------------------------------------------------|
+| amd64        | AM4                     | Works across all amd64 platforms.                                                        |
+| amd64-v3     | AM4                     | Snake oil level optimizations with AVX. It mostly reduces response compression overhead. |
+| amd64-v4     | Not Tested              | Snake oil level optimizations with AVX-512.                                              |
+| arm64        | Raspberry Pi 4 Model B  |                                                                                          |
+| armv7        | Qemu emulation          |                                                                                          |
+| armv6        | Qemu emulation          |                                                                                          |
+| riscv64      | Qemu emulation          |                                                                                          |
+
 ![DetailImage](docs/images/details.webp)
 
 ![ListImage](docs/images/list.webp)
 
 ![INSTCMDImage](docs/images/inst_cmd.webp)
 
-## Command-Line Arguments
+## Command-Line arguments
 
-The following command-line arguments can be used to configure the application:
+* `--poll-freq`: UPS[pollfreq](https://networkupstools.org/docs/man/ups.conf.html#_global_directives) in seconds. Default is `30`.
+* `--poll-interval`: UPS [pollinterval](https://networkupstools.org/docs/man/ups.conf.html#_global_directives) in seconds. Default is `2`.
+* `--upsd-addr`: UPS daemon address. Default is `localhost`.
+* `--upsd-port`: UPS daemon port. Default is `3493`.
+* `--upsd-user`: UPS daemon username.
+* `--upsd-pass`: UPS daemon password.
+* `--listen`: Listen address for the HTTP server. Default is `0.0.0.0`.
+* `--port`: Port used by the HTTP server. Default is `9000`.
+* `--log-level`: Log level for the HTTP server. Default is `info`.
+* `--static-dir`: Directory path for static files. Default is `./static`.
 
-* `--poll-freq`: Specify the poll frequency in seconds. Default is `10`.
-* `--upsd-addr`: Specify the UPS daemon address. Default is `localhost`.
-* `--upsd-port`: Specify the UPS daemon port. Default is `3493`.
-* `--upsd-user`: Specify the UPS daemon username.
-* `--upsd-pass`: Specify the UPS daemon password.
-* `--listen`: Specify the listen address for the HTTP server. Default is `0.0.0.0`.
-* `--port`: Specify the port used by the HTTP server. Default is `9000`.
-* `--log-level`: Specify the log level for the HTTP server. Default is `info`.
-* `--static-dir`: Specify the location of static css and js files served by the HTTP server. Default is `./static`.
+## Container image environment variables
 
-## Container Image Environment Variables
+* `POLL_FREQ`: UPS [pollfreq](https://networkupstools.org/docs/man/ups.conf.html#_global_directives) in seconds. Default is `30`.
+* `POLL_INTERVAL`: UPS [pollinterval](https://networkupstools.org/docs/man/ups.conf.html#_global_directives) in seconds. Default is `2`.
+* `UPSD_ADDR`: UPS daemon address. Default is `localhost`.
+* `UPSD_PORT`: UPS daemon port. Default is `3493`.
+* `UPSD_USER`: UPS daemon username.
+* `UPSD_PASS`: UPS daemon password.
+* `LISTEN`: Listen address for the HTTP server. Default is `0.0.0.0`.
+* `PORT`: Port used by the HTTP server. Default is `9000`.
+* `LOG_LEVEL`: Log level. Default is `info`.
 
-The following environment variables can be used to configure the application:
+> amd64 v3 and v4 variants require certain CPU feature flags to run. If you are a crackhead min-max enjoyer (like me), you can use `nut_webgui:latest-amd64-v3` and `nut_webgui:latest-amd64-v4` images.
+> See [x86-64 Microarchitecture levels](https://en.wikipedia.org/wiki/X86-64#Microarchitecture_levels) for more details.
 
-* `POLL_FREQ`: Specify the poll frequency in seconds. Default is `10`.
-* `UPSD_ADDR`: Specify the UPS daemon address. Default is `localhost`.
-* `UPSD_PORT`: Specify the UPS daemon port. Default is `3493`.
-* `UPSD_USER`: Specify the UPS daemon username.
-* `UPSD_PASS`: Specify the UPS daemon password.
-* `LISTEN`: Specify the listen address for the HTTP server. Default is `0.0.0.0`.
-* `PORT`: Specify the port used by the HTTP server. Default is `9000`.
-* `LOG_LEVEL`: Specify the log level for the HTTP server. Default is `info`.
-
-## JSON Data API
+## JSON data API
 
 A simple JSON-based API is available for integration and automation purposes. For usage details
 see [JSON data API page.](./docs/json_api.md)
@@ -68,3 +79,7 @@ checks in your systems.
 
 - [Kubernetes with EndpointSlice](docs/kubernetes_example.md)
 - [Docker compose](docs/docker_compose.md)
+
+## Building from source and debugging
+
+See [Building and Debugging.](./docs/building_debugging.md)

Diff for: build_images.sh

@@ -115,7 +115,7 @@ for TARGET_FILE in ${DOCKER_FILES}; do
     echo -e "${C_Cy}Dockerfile ${TARGET_FILE}${RST}";
     echo -e "${C_Cy}Building ${_IMAGE_TAG}${RST}";
 
-    test "${DRY_RUN}" = "false" && \
+    test "${DRY_RUN}" != "true" && \
         buildah build \
         --layers \
         --variant "${_ARCH_VARIANT}" \
@@ -169,8 +169,7 @@ for IMAGE in ${CREATED_IMAGES}; do
     echo -e "${C_Y}${IMAGE} added to ${MANIFEST_NAME}${RST}.";
 done;
 
-if [[ "$PUBLISH" == "true" ]];
-then
+if [[ "$PUBLISH" == "true" ]]; then
     test "${DRY_RUN}" != "true" && \
         buildah login --tls-verify="${TLS_VERIFY}" "${REGISTRY}"
 

Diff for: client/package.json

@@ -5,7 +5,7 @@
   },
   "private": true,
   "name": "nut_webgui-client",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Bundles all client side web components and dependencies.",
   "scripts": {
     "dev-js": "esbuild ./src/index.js --bundle --outdir=./dist/debug --target=firefox98,chrome86,safari15 --format=iife --watch=forever",
@@ -17,7 +17,7 @@
   "devDependencies": {
     "daisyui": "^4.12.10",
     "esbuild": "^0.23.0",
-    "tailwindcss": "^3.4.4",
+    "tailwindcss": "^3.4.6",
     "typescript": "^5.5.3"
   },
   "dependencies": {

Diff for: client/pnpm-lock.yaml

@@ -1,4 +1,4 @@
-FROM --platform=linux/riscv64 docker.io/busybox:stable-glibc
+FROM --platform=linux/riscv64 docker.io/busybox:stable-musl
 RUN adduser -H -D -g "<nut_web>" nut_webgui
 COPY --chmod=750 --chown=root:nut_webgui ./containers/server_start.sh /opt/nut_webgui/server_start.sh
 COPY --chmod=750 --chown=root:nut_webgui ./bin/riscv64gc-gnu/nut_webgui /opt/nut_webgui/nut_webgui

Diff for: containers/riscv64.Dockerfile

@@ -4,11 +4,12 @@ BIN_LOCATION=/opt/nut_webgui/nut_webgui
 STATIC_LOCATION=/opt/nut_webgui/static
 
 exec "$BIN_LOCATION" --static-dir "$STATIC_LOCATION" \
-${LISTEN:+"--listen=$LISTEN"} \
-${PORT:+"--port=$PORT"} \
-${POLL_FREQ:+"--poll-freq=$POLL_FREQ"} \
-${UPSD_PORT:+"--upsd-port=$UPSD_PORT"} \
-${UPSD_ADDR:+"--upsd-addr=$UPSD_ADDR"} \
-${UPSD_USER:+"--upsd-user=$UPSD_USER"} \
-${UPSD_PASS:+"--upsd-pass=$UPSD_PASS"} \
-${LOG_LEVEL:+"--log-level=$LOG_LEVEL"}
+    ${LISTEN:+"--listen=$LISTEN"} \
+    ${PORT:+"--port=$PORT"} \
+    ${POLL_FREQ:+"--poll-freq=$POLL_FREQ"} \
+    ${POLL_INTERVAL:+"--poll-interval=$POLL_INTERVAL"} \
+    ${UPSD_PORT:+"--upsd-port=$UPSD_PORT"} \
+    ${UPSD_ADDR:+"--upsd-addr=$UPSD_ADDR"} \
+    ${UPSD_USER:+"--upsd-user=$UPSD_USER"} \
+    ${UPSD_PASS:+"--upsd-pass=$UPSD_PASS"} \
+    ${LOG_LEVEL:+"--log-level=$LOG_LEVEL"}

Diff for: containers/server_start.sh

@@ -0,0 +1,58 @@
+# Building code from source
+
+## Linux:
+
+### Requirements:
+Required host tools are:
+  - make
+  - cargo
+  - node
+  - pnpm
+  - jq
+
+Optionally, You need the following packages and Rust targets for cross-compilation.
+
+Required packages:
+  - riscv64-linux-gnu-gcc
+  - aarch64-linux-gnu-gcc
+
+Required Rust targets:
+  - aarch64-unknown-linux-gnu
+  - aarch64-unknown-linux-musl
+  - arm-unknown-linux-musleabi
+  - armv7-unknown-linux-musleabi
+  - riscv64gc-unknown-linux-gnu
+  - x86_64-unknown-linux-gnu
+  - x86_64-unknown-linux-musl
+
+### Building
+
+```shell
+make build
+
+# Output dirs ./bin/release/ and ./bin/static
+```
+or cross-compile everything (x86-64, ARM64-v8, ARM7, ARM6, RISC-V64)
+
+```shell
+make build-all
+
+# Output dirs ./bin/<target-name> and ./bin/static
+```
+
+### Developing & Debugging
+
+You can start front-end and back-end server via `./start_dev.sh`. It simply calls [`cargo-watch`](https://github.com/watchexec/cargo-watch), esbuild and tailwind.
+
+```shell
+# Set your NUT server address
+export UPSD_ADDR="10.0.0.0"
+
+# (Optional) set username and password for testing INST_CMD.
+export UPSD_USER="user_name"
+export UPSD_PASS="yo"
+
+./start_dev.sh
+```
+
+> Check available recipes inside the [Makefile](../Makefile).

Diff for: docs/building_debugging.md

@@ -2,7 +2,7 @@
 
 # External Host
 ```
-┌──────┐                                    
+┌──────┐
 │ UPS1 ├──┐                                                  ┌─┐
 └──────┘  │     Server A                   Server B          │C│
           │     ┌─────────────┐            ┌───────────┐     │L│
@@ -26,14 +26,15 @@ services:
       - 80:1234
     environment:
       POLL_FREQ: "60"
+      POLL_INTERVAL: "5"
       UPSD_ADDR: "myhost"
       UPSD_PORT: "1234"
       UPSD_USER: "admin"
       UPSD_PASS: "test"
       LISTEN: "0.0.0.0"
       PORT: "1234"
       LOG_LEVEL: "debug"
-      
+
 # Add other services, reverse proxy of your choice etc.
 ```
 
@@ -63,6 +64,7 @@ services:
     network_mode: host         # Share same host
     environment:
       POLL_FREQ: "60"
+      POLL_INTERVAL: "5"
       UPSD_ADDR: "localhost"
       UPSD_PORT: "3493"
       UPSD_USER: "admin"

Diff for: docs/docker_compose.md

@@ -1,4 +1,4 @@
-### Kubernetes with EndpointSlice
+# Kubernetes with EndpointSlice
 
 Example topology