publicWagsHome
/
amcrest2mqtt
mirror of https://github.com/dchesterton/amcrest2mqtt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
dependabot/github_actions/docker/setup-buildx-action-2.5.0
dependabot/pip/python-slugify-8.0.1
dependabot/github_actions/docker/build-push-action-4.0.0
dependabot/github_actions/docker/setup-qemu-action-2.1.0
dependabot/github_actions/docker/login-action-2.1.0
main
1.0.16
1.0.15
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'c9d3a21ab5'
${ noResults }
amcrest2mqtt/ENVIRONMENT_VARIABLES.md

2.1 KiB
Raw Blame History

Environment Variables

While using a config.yaml file is the recommended approach, amcrest2mqtt also supports configuration via environment variables.

Amcrest Camera Settings

  • AMCREST_HOSTS (required, 1+ space-separated list of hostnames/ips)
  • AMCREST_NAMES (required, 1+ space-separated list of device names - must match count of AMCREST_HOSTS)
  • AMCREST_PORT (optional, default = 80)
  • AMCREST_USERNAME (optional, default = admin)
  • AMCREST_PASSWORD (required)

WebRTC Settings

  • AMCREST_WEBRTC_HOST (optional, webrtc hostname for link, but then link/sources below become required:)
  • AMCREST_WEBRTC_PORT (webrtc port, default = 1984)
  • AMCREST_WEBRTC_LINK (webrtc stream link, default = 'stream.html')
  • AMCREST_WEBRTC_SOURCES (webrtc "Source" param for each camera, same count and order of AMCREST_HOSTS above)

MQTT Settings

  • MQTT_USERNAME (required)
  • MQTT_PASSWORD (optional, default = empty password)
  • MQTT_HOST (optional, default = 'localhost')
  • MQTT_QOS (optional, default = 0)
  • MQTT_PORT (optional, default = 1883)
  • MQTT_PROTOCOL (optional, default = '5') - MQTT protocol version: '3.1.1' or '5'
  • MQTT_TLS_ENABLED (required if using TLS) - set to true to enable
  • MQTT_TLS_CA_CERT (required if using TLS) - path to the ca certs
  • MQTT_TLS_CERT (required if using TLS) - path to the private cert
  • MQTT_TLS_KEY (required if using TLS) - path to the private key
  • MQTT_PREFIX (optional, default = amcrest2mqtt)
  • MQTT_DISCOVERY_PREFIX (optional, default = 'homeassistant')

Media/Recording Settings

  • MEDIA_PATH (optional) - path to store motion recordings (mp4) files
  • MEDIA_MAX_SIZE (optional, default = 25) - max size per recording in MB
  • MEDIA_RETENTION_DAYS (optional, default = 7) - days to keep recordings, 0 = disabled
  • MEDIA_SOURCE (optional) - HomeAssistant url for accessing those recordings (see config.yaml.sample)

Update Intervals

  • STORAGE_UPDATE_INTERVAL (optional, default = 900) - how often to fetch storage stats (in seconds)
  • SNAPSHOT_UPDATE_INTERVAL (optional, default = 60) - how often to fetch camera snapshot (in seconds)