go2rtc smart home integration, free and open source
go2rtc streams as Gladys cameras: RTSP, HomeKit, Tapo, USB… go2rtc bundled or your own.
Published by LM1LC3N7
- Devices
- Version 0.1.1
- Requires Gladys >=5.1.0
- ★ 0
Unofficial integration, not affiliated with the go2rtc project. It turns the streams of a go2rtc server into Gladys cameras. go2rtc (open source, by AlexxIT) speaks almost every camera language: RTSP and ONVIF cameras, HomeKit cameras (Aqara G100…), TP-Link Tapo and Kasa, Xiaomi, DVR-IP recorders, Ring, Tuya, USB webcams, HTTP snapshot URLs… One go2rtc stream = one camera in Gladys, whatever the brand.
Two ways to use it:
- the go2rtc run by Gladys: nothing to install, Gladys starts the official go2rtc image next to the integration; you type your streams in the configuration, or add them in the go2rtc web page;
- your own go2rtc: a go2rtc you already run (Docker, Home Assistant add-on…), or the one inside Frigate.
Development version (0.1): tested against a real go2rtc 1.9.14 fed by video test patterns (H.264, MJPEG, a network camera broken and repaired), not yet with real cameras. Tell us on the forum what works with yours.
What you get
| Surface | Content |
|---|---|
| One camera per stream | Its image on the dashboard, refreshed at the pace you choose; a fresh image when you open the live view or a scene sends the camera image |
| A badge per camera | local while the camera sends images to go2rtc, unreachable after two failed reads in a row |
| Scene triggers | Camera offline (the camera does not answer, its stream left go2rtc, or go2rtc does not answer) and Camera back online |
| Buttons of the configuration | Test the connection to go2rtc, Check every stream (go2rtc connects each one: online with its video codec, or why not) |
| go2rtc run by Gladys | Its web page (live video in WebRTC or MSE, adding streams, HomeKit pairing) and an RTSP restream of every stream for other software (VLC, NVR…) |
The go2rtc run by Gladys
- Install the integration. In Configuration, keep The go2rtc run by Gladys.
- Choose a Web password: it protects the go2rtc web page and the RTSP
restream (user
admin). Without it, Gladys picks a random password and the web page stays closed. - Fill a Stream: name and a Stream: source per camera (6 slots; for more, add them in the go2rtc web page). The name becomes the camera name in Gladys; renaming it later creates a new camera.
- Save. The first start downloads the go2rtc image (about 95 MB): the status may say "does not answer yet" for a minute.
- Open Discovery and add your cameras.
Examples of sources (see the go2rtc documentation):
| Camera | Source |
|---|---|
| RTSP (most IP cameras) | rtsp://user:[email protected]:554/stream1 |
| ONVIF | onvif://user:[email protected] |
| TP-Link Tapo (no RTSP) | tapo://[email protected] |
| DVR-IP recorder (XMeye) | dvrip://user:[email protected]:34567?channel=0&subtype=0 |
| HTTP snapshot or MJPEG | http://192.168.1.23/snapshot.jpg or ffmpeg:http://192.168.1.23/video.mjpg#video=h264 |
| USB webcam on this server | ffmpeg:device?video=0&video_size=1280x720#video=h264 (see below) |
USB webcam: the go2rtc container only sees the video devices you allow.
Grant the video hardware to the go2rtc container in Gladys (install
screen, or the hardware access of the integration), then use the source
above (video=0 is /dev/video0). #video=h264 makes go2rtc encode H.264
for the browsers; it costs CPU (the container may use one core).
The web page: the address is in the configuration screen
(http://<your Gladys>:<port>/), and the supervision of the integration
shows an "Open" link. Log in with admin and your web password. The video
plays in WebRTC or MSE. For WebRTC, type the IP address of the Gladys
machine in Address of this Gladys machine (WebRTC); without it the page
uses MSE, which works in recent browsers (Chrome, Firefox, Edge, Safari 17+).
RTSP restream: rtsp://admin:<web password>@<your Gladys>:<port>/<stream name>
(the port is in the configuration screen). Handy to feed another software
with the cameras go2rtc already reaches (Tapo, HomeKit…).
Your own settings: Gladys writes the streams of the form in
gladys.yaml and never touches go2rtc.yaml next to it, which the go2rtc
web page edits (Config): a stream added there, a HomeKit pairing, your
ffmpeg presets survive restarts and updates. The settings Gladys needs
(API and RTSP password, ports, logs) and the streams of the form win over
the same keys of go2rtc.yaml.
HomeKit cameras (Aqara G100…): go2rtc needs mDNS with them, to pair
and to find them again, and mDNS does not cross the isolated network of the
Gladys containers. Run go2rtc on the host network (Docker
network_mode: host), pair the camera in its web page, then choose your
own go2rtc below.
Your own go2rtc (or Frigate's)
- In Configuration, choose My own go2rtc server (or Frigate's).
- go2rtc address: the address of its API, port 1984 by default:
http://192.168.1.10:1984. Use the LAN address of the machine:localhostwould point inside the Gladys containers. - If go2rtc asks for a password (
api: username / passwordin its config), fill go2rtc user name and go2rtc password. - Save, then open Discovery: every stream of your go2rtc is listed.
Frigate: Frigate runs go2rtc inside its container on port 1984. Publish
it in your docker-compose.yml (- "1984:1984" under ports:), then use
http://<Frigate host>:1984. That port has no password unless you set one
in the go2rtc: section of Frigate's config (api: username / password):
keep it on your local network. The cameras of Frigate's go2rtc are the ones
of its go2rtc: streams: section.
Gladys only reads your go2rtc (the stream list and snapshots): it never changes its configuration. When you choose this mode, the go2rtc run by Gladys is stopped.
Images
- The dashboard shows the last image Gladys received; Image refresh sets how often a new one is sent (every 5 seconds to every 10 minutes, or none). Each image is a snapshot: go2rtc connects to the camera if nobody watches it, waits for a key frame and converts it to JPEG. A fast pace loads your cameras and the Gladys machine more; one image a minute is a good start.
- The live view (and the "send a camera image" scene action) asks for a fresh image, up to 1280 pixels wide.
- Gladys accepts images up to 150 KB (60 KB for the image kept on the camera): go2rtc resizes H.264 and H.265 streams itself; an MJPEG stream (USB webcam, HTTP camera) is resized by the integration.
- With None, no image is sent and each camera's status is checked every 5 minutes.
Scenes
- Camera offline: a camera (or none for any) and optionally a reason:
source(the camera does not answer go2rtc),server(go2rtc does not answer),removed(the stream is no longer in go2rtc). Variables: the stream name and the reason. A camera is offline after two failed reads in a row, so a single hiccup sends nothing. - Camera back online: a camera that was offline sends images again.
A camera that is already offline when the integration starts sends no event: only changes do.
Troubleshooting
- "go2rtc does not answer": check the address and the port, and that the go2rtc machine accepts connections from the Gladys machine.
- "refused the user name or password": the
api:user and password of your go2rtc. - "does not answer like go2rtc": the address points to another service (the RTSP port 8554, Frigate's web port…): use the API port, 1984.
- "The go2rtc container could not start": see the logs of the integration (Configuration → supervision); the go2rtc image may not be downloaded yet.
- A camera stays unreachable: press Check every stream: go2rtc says why (timeout, refused password, unknown codec). Try the same source in the go2rtc web page.
- The integration never writes a camera address or password in its logs.
Privacy
Everything stays on your network: the integration talks to go2rtc only, and go2rtc to your cameras. Camera addresses typed in the configuration are stored by Gladys like any configuration value (visible to Gladys administrators). The go2rtc run by Gladys always asks for a password on its web page and RTSP restream, because Gladys publishes those ports on your local network.
Configuration settings
These are the settings go2rtc asks for in its configuration screen in Gladys.
| Setting | Type | Required | Description |
|---|---|---|---|
| How it works | section | No | go2rtc (open source, by AlexxIT) turns almost any camera into a stream: RTSP and ONVIF cameras, HomeKit cameras (Aqara G100…), Tapo, Xiaomi, DVR-IP recorders, USB webcams, HTTP snapshots. Each go2rtc stream becomes a Gladys camera (Discovery tab), with an image refreshed at the pace chosen below and an online / offline badge. Use the go2rtc that Gladys runs (nothing to install), or your own (Frigate's too). Unofficial integration, not affiliated with the go2rtc project. |
| go2rtc server | select | Yes | |
| go2rtc run by Gladys | section | No | Gladys runs the official go2rtc image next to this integration. Its web page (live video, adding streams, HomeKit pairing): http://{{gladys_host}}:{{port:go2rtc_web}}/ with the user admin and the web password below. RTSP restream for other software: rtsp://admin:<web password>@{{gladys_host}}:{{port:go2rtc_rtsp}}/<stream name>. USB webcam: grant the video hardware to the go2rtc container in Gladys, then use the source ffmpeg:device?video=0#video=h264. |
| Web password | secret | No | Password of the go2rtc web page and of the RTSP restream (user admin). Empty: Gladys picks a random one and the web page stays closed. |
| Stream 1: name | string | No | Name of the stream in go2rtc and of the camera in Gladys (empty: camera_1). Renaming it later makes a new camera. |
| Stream 1: source | string | No | Any go2rtc source: rtsp://user:password@192.168.1.20:554/stream1, onvif://…, homekit://…, tapo://…, ffmpeg:device?video=0#video=h264 (USB webcam)… Leave it empty to remove the stream. |
| Stream 2: name | string | No | |
| Stream 2: source | string | No | |
| Stream 3: name | string | No | |
| Stream 3: source | string | No | |
| Stream 4: name | string | No | |
| Stream 4: source | string | No | |
| Stream 5: name | string | No | |
| Stream 5: source | string | No | |
| Stream 6: name | string | No | |
| Stream 6: source | string | No | More streams: add them in the go2rtc web page, they show up in Discovery too. |
| Address of this Gladys machine (WebRTC) | string | No | Optional: the IP address of this Gladys machine on your network, for WebRTC in the go2rtc web page. Without it, the page plays the video over MSE, which works in recent browsers. |
| Your own go2rtc server | section | No | The address of its API, port 1984 by default (e.g. http://192.168.1.10:1984). With Frigate, publish port 1984 of the Frigate container ("1984:1984") and use http://<Frigate host>:1984. If go2rtc asks for a password (api: username / password), fill both fields. Gladys only reads the streams and their snapshots: it never changes your go2rtc. |
| go2rtc address | string | No | |
| go2rtc user name | string | No | |
| go2rtc password | secret | No | |
| Images in Gladys | section | No | Gladys shows the last image of each camera on the dashboard, and asks for a fresh one in the live view. Each image is a snapshot: go2rtc connects to the camera when nobody watches it, so a faster pace loads the cameras and this machine more. |
| Image refresh | select | Yes |
How to install go2rtc in Gladys
- In Gladys, open Integrations: go2rtc appears in the catalog, next to the native integrations, with a community badge.
- Click Install. Gladys pulls the Docker image (
ghcr.io/lm1lc3n7/gladys-go2rtc:0.1.1), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration). - Open the Configuration screen of the integration, fill in the settings, and save.
- You can also install it directly from its repository URL: https://github.com/LM1LC3N7/gladys-go2rtc.
go2rtc requires Gladys >=5.1.0. The catalog inside Gladys refreshes every hour, so a new version becomes available at most one hour after its release.
Not running Gladys yet? It is free and open source: follow the installation guide to get started.
About external integrations
go2rtc is an external integration: a community integration packaged as a Docker container and published on GitHub, that Gladys installs in one click and runs in a sandbox isolated from its core. It is published and maintained by LM1LC3N7, not by the Gladys core team.
- Browse all integrations, native and community
- Build and publish your own external integration
- Source code on GitHub — source of this documentation