WebUI

Important

WebUI and stream authentication will be enabled by default to prevent unintentional access.

Please see the Authentication page for more information.

Snapshots

Cached snapshots are accessible using the /img/cam-name.jpg endpoint. A new snapshot will be generated if an existing one is not found.

http://localhost:5000/img/camera-nickname.jpg

You can also set the maximum age of the image with the exp parameter, so that it will generate a new snapshot if the existing one is older than the exp age in seconds:

http://localhost:5000/img/camera-nickname.jpg?exp=90

New snapshots can also be generated on demand using the URI:

http://localhost:5000/snapshot/camera-nickname.jpg

Thumbnails from the wyze API can also be accessed using the URI:

http://localhost:5000/thumb/camera-nickname.jpg

Query Parameters

Query parameters to adjust web-ui from the url:

• Fullscreen/kiosk mode:
  • http://localhost:5000/?fullscreen
• Number of columns:
  • http://localhost:5000/?columns=4
• Preview refresh interval:
  • http://localhost:5000/?refresh=60
• Camera order:
  • http://localhost:5000/?order=front-cam,back-cam,garage,other
• autoplay:
  • http://localhost:5000/?autoplay
• Use WebRTC for WebUI (will fall back to HLS if WB_IP is not set):
  • http://localhost:5000/?webrtc
• Use HLS for WebUI:
  • http://localhost:5000/?hls

NOTE: You can mix and match multiple queries into a single request:

http://localhost:5000/?fullscreen&autoplay&columns=2&refresh=0&order=front,side

Custom Ports

If you're running the WebUI behind a reverse-proxy or need to change the hostname and/or port for each stream, you can do so by passing the needed ENVs:

environment:
  - WB_RTSP_URL=rtsp://my-hostname-or-ip:1234/
  - WB_RTMP_URL=rtmp://my-hostname-or-ip:5678/
  - WB_HLS_URL=http://my-hostname-or-ip:9090/
  - WB_WEBRTC_URL=http://my-hostname-or-ip:9091/

WebUI API

See the WebUI API page for additional information