Skip to content

Setup & Usage

Prerequisites

  • Python 3.10+
  • Docker & Docker Compose
  • Linux/Ubuntu recommended

Installation

sudo apt-get install python3-pip openssh-server
pip3 install -r requirements.txt
sudo apt update
sudo apt install apt-transport-https ca-certificates curl software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
sudo apt install docker-ce
sudo curl -L https://github.com/docker/compose/releases/download/v2.4.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

Configuration

  • Set MASTER_PASSWORD_FROM_SHELL in your shell profile
  • Run python scripts/manage_secrets.py to create encrypted secrets
  • Edit scripts/.env for device-specific settings

Build & Run

sudo ./docker_build.sh
sudo docker-compose -f docker/docker-compose.yaml up -d

Test MQTT

python scripts/test_mqtt.py