Getting Started

The project is deployed as a Docker container.

Prerequisites

• Docker
• Docker Compose
• InfluxDB 2.x (The latest version of the Sense Collector no longer works with InfluxDB V1)
• Grafana 11.0.0

Deploying the Sense Collector

Use the following Docker container:

lux4rd0/sense-collector:2.0.07
lux4rd0/sense-collector:latest

Correct environmental variables are required for the container to function.

SENSE_COLLECTOR_API_PASSWORD
SENSE_COLLECTOR_API_USERNAME
SENSE_COLLECTOR_INFLUXDB_BUCKET
SENSE_COLLECTOR_INFLUXDB_ORG
SENSE_COLLECTOR_INFLUXDB_TOKEN
SENSE_COLLECTOR_INFLUXDB_URL

Example command line (be sure to change all variables):

docker run --rm \
  --name=sense-collector-53997 \
  -e SENSE_COLLECTOR_API_PASSWORD=CHANGEME \
  -e [email protected] \
  -e SENSE_COLLECTOR_INFLUXDB_BUCKET=sense \
  -e SENSE_COLLECTOR_INFLUXDB_ORG=Lux4rd0 \
  -e SENSE_COLLECTOR_INFLUXDB_TOKEN=TOKEN \
  -e SENSE_COLLECTOR_INFLUXDB_URL=http://sense-collector.lux4rd0.com:8086 \
  -e TZ=America/Chicago \
  --restart always \
  lux4rd0/sense-collector:latest

Running docker compose up -d or the docker-run command will download and start the sense-collector container.