Setup.md

Boilr Setup

• Boilr Setup
  • Containerised in Docker (recommended)
    • Manually building & run container
    • Docker Hub (ARMv6 only)
  • PyPI - Python Package Index
  • Manually build and install package

Containerised in Docker (recommended)

Manually building & run container

docker-compose build
docker-compose up -d

Docker Hub (ARMv6 only)

docker run --privileged -v ./config.yaml:/etc/boilr/config.yaml --device /dev/gpiomem:/dev/gpiomem peterbrain/boilr:latest

Note

In order to install and use Docker on a Raspberry Pi 1 Model B, I had to set sysctl vm.overcommit_memory=1 and restart after the installation.

PyPI - Python Package Index

Boilr is not yet available on Python Package Index. Check back later

Manually build and install package

pip install .

Create config folder and copy sample config file to config directory.

mkdir /etc/boilr
cp config.yaml /etc/boilr/

Edit the config file to your needs. Check out this Sample configuration for reference.

vi /etc/boilr/config.yaml