From a72384322d9a06c4acd8f5696bd2349489b3bfee Mon Sep 17 00:00:00 2001 From: Vadim Tkachenko Date: Tue, 27 Feb 2024 01:25:14 -0700 Subject: [PATCH] Documented quirks related to building the Docker container on Raspberry Pi --- docs/build/index.md | 5 ++++- docs/platform.md | 7 ++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/build/index.md b/docs/build/index.md index 9b53d5422..9102d91a1 100644 --- a/docs/build/index.md +++ b/docs/build/index.md @@ -34,7 +34,10 @@ When completed successfully, it will create a set of executable scripts and exec ### Docker #### Local Image -* To execute this variant, you need to first build it with `./gradlew jibDockerBuild` (assuming you granted your build user permissions to run Docker tools) and then run the image with configuration, logs, and connector directories exposed as volumes. Details are coming soon. +* To execute this variant, you need to first build it with `./gradlew jibDockerBuild` +(assuming you [granted your build user permissions to run Docker tools](https://docs.docker.com/go/rootless/)) and then run the image with configuration, logs, and connector directories exposed as volumes. +Don't forget [#305](https://github.com/home-climate-control/dz/issues/305) if you're building the container on a Raspberry Pi. +More details are coming soon. * When to use: if you want to tinker with the code and still run it from Docker. #### Public Image diff --git a/docs/platform.md b/docs/platform.md index 45317f335..3e33869de 100644 --- a/docs/platform.md +++ b/docs/platform.md @@ -3,9 +3,10 @@ Home Climate Control: Platform Support ## Current Development Tree -No clear answer other than "it runs on UNIX", it is quite possible that HCC will work on Raspberry Pi 3 Model B and up, but it hasn't been tested yet. - -It definitely works in a Docker container. +No clear answer much beyond "it runs on UNIX", and +* it takes great pains to build on Raspberry Pi 3 Model B+, you need to stop all non-essential services, [give it lots of swap space](https://pimylifeup.com/raspberry-pi-swap-file/), and build it without running test cases for good measure; +* it builds on Raspberry Pi 5 without any precautions, however, you will have to [make one extra step](https://github.com/home-climate-control/dz/issues/305) if you want to run it in a Docker container. +* It definitely works in a Docker container. Stay tuned, more to come. Meanwhile, see [Build](./build/index.md).