Sign inSign up

theyosh/terrariumpi

By theyosh

•Updated about 2 hours ago

Home automated terrarium/aquarium or other enclosed environment with a Raspberry Pi

Image
Internet of things
2

10K+

theyosh/terrariumpi repository overview

⁠TerrariumPI Docker Image

This is the official Docker image for TerrariumPI. There should be a new image every new release.

⁠Versions

Currently there are docker images for OS Buster, Bullseye and Bookworm. And for all OS images there is a version with -java for Denkovi Relays. You can swap between java and non java without problems.

Take note: Make sure you use the same docker image OS version as your host version. Is your Raspberry PI running Bookworm OS, use the -bookworm image. Else you can get strange results with the Raspberry PI cam, I2C and maybe bluetooth!

Take care about the mount volumes. See the comments which lines you need for which OS.

⁠Quick start

  1. Copy docker-compose.yml.example to docker-compose.yml and update as needed. See example below: Docker-compose⁠ example:
services:
  terrariumpi:
    image: theyosh/terrariumpi:[X.Y.Z-OS] # Or use a specific version
    volumes:
      - /opt/terrariumpi/logs:/TerrariumPI/log
      - /opt/terrariumpi/data:/TerrariumPI/data
      - /opt/terrariumpi/media:/TerrariumPI/media
      - /opt/terrariumpi/scripts:/TerrariumPI/scripts
      - /opt/terrariumpi/webcam-archive:/TerrariumPI/webcam/archive
      # Line below only needed for Denkovi Relays. Needs -java image
      - /opt/terrariumpi/DenkoviRelayCommandLineTool:/TerrariumPI/3rdparty/DenkoviRelayCommandLineTool

      - /boot/config.txt:/boot/config.txt # For Buster and Bullseye
      - /boot/cmdline.txt:/boot/cmdline.txt # For Buster and Bullseye

      - /boot/firmware/config.txt:/boot/firmware/config.txt # For Bookworm
      - /boot/firmware/cmdline.txt:/boot/firmware/cmdline.txt # For Bookworm
      - /run/udev:/run/udev # For Bookworm

      - /etc/modules:/etc/modules
      - /dev:/dev
    network_mode: host
    restart: unless-stopped
    privileged: true
    cap_add:
      - NET_ADMIN
    stop_grace_period: 1m
    stop_signal: SIGINT
    init: true
    environment:
      TZ: "Europe/Amsterdam" # timezone list can be found here https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
      ENABLE_I2C: "true"
      ENABLE_1_WIRE: "true"
      ENABLE_CAMERA: "true"
      ENABLE_SERIAL: "true"
      ENABLE_CO2_SENSORS: "true"
      AUTO_REBOOT: "true"

  1. Run docker compose pull to pull the image. That can take some time.

  2. Run docker compose up -d to build and start TerrariumPI. The -d is important.

We run the container with privileged⁠ enabled. This is less secure, but needed in order to be able to handle all the hardware that is connected to the Raspberry PI.

And the docker container should start automatically the next reboot of the Raspberry PI.

⁠More information

You can find more information at

Tag summary

Content type

Image

Digest

sha256:5a07930be…

Size

361.3 MB

Last updated

about 2 hours ago

docker pull theyosh/terrariumpi:development-trixie