Skip to content

Commit

Permalink
Documented quirks related to building the Docker container on Raspber…
Browse files Browse the repository at this point in the history
…ry Pi
  • Loading branch information
climategadgets committed Feb 27, 2024
1 parent ce2054d commit a723843
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
5 changes: 4 additions & 1 deletion docs/build/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down

0 comments on commit a723843

Please sign in to comment.