From 11e3e8a2776154b8b585d841df15c4bab2aa4195 Mon Sep 17 00:00:00 2001 From: Robert Resch Date: Tue, 5 Nov 2024 10:53:00 +0100 Subject: [PATCH] Add go2rtc (#34998) * Add go2rtc * fix finding * fix * formatting * fix * Update source/_integrations/go2rtc.markdown Co-authored-by: Martin Hjelmare * Update docs * Move it to config * Add warning for debug_ui * Apply suggestions from code review Co-authored-by: Martin Hjelmare * Style tweaks Co-authored-by: Martin Hjelmare * Update source/_integrations/go2rtc.markdown * Add more context Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * Fix grammar --------- Co-authored-by: Martin Hjelmare Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --- source/_integrations/default_config.markdown | 1 + source/_integrations/go2rtc.markdown | 58 ++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 source/_integrations/go2rtc.markdown diff --git a/source/_integrations/default_config.markdown b/source/_integrations/default_config.markdown index 6158eee9346..7e07591bc9d 100644 --- a/source/_integrations/default_config.markdown +++ b/source/_integrations/default_config.markdown @@ -20,6 +20,7 @@ This {% term integration %} is a meta-component and configures a default set of - [Conversation](/integrations/conversation/) (`conversation`) - [DHCP discovery](/integrations/dhcp/) (`dhcp`) - [Energy](/integrations/energy/) (`energy`) +- [Go2rtc](/integrations/go2rtc/) (`go2rtc`) - [History](/integrations/history/) (`history`) - [Home Assistant Alerts](/integrations/homeassistant_alerts) (`homeassistant_alerts`) - [Home Assistant Cloud](/integrations/cloud/) (`cloud`) diff --git a/source/_integrations/go2rtc.markdown b/source/_integrations/go2rtc.markdown new file mode 100644 index 00000000000..523f6112d31 --- /dev/null +++ b/source/_integrations/go2rtc.markdown @@ -0,0 +1,58 @@ +--- +title: go2rtc +description: Instructions on how to setup go2rtc in Home Assistant. +ha_category: + - Camera +ha_release: 2024.11 +ha_iot_class: Local Polling +ha_codeowners: + - '@home-assistant/core' +ha_domain: go2rtc +ha_integration_type: system +related: + - docs: /installation/ +--- + +go2rtc is an open source project providing a camera streaming application that supports formats such as RTSP, WebRTC, HomeKit, FFmpeg, RTMP. The **go2rtc** {% term integration %} connects to a go2rtc instance and provides a WebRTC proxy for all your cameras. To learn more about go2rtc, refer to the [project's GitHub page](https://github.com/AlexxIT/go2rtc/). + + +If you are using the [`default_config`](/integrations/default_config/) and run Home Assistant using one of the following installation methods, the go2rtc integration will be set up automatically and you don't need to do anything: + +- {% term "Home Assistant Operating System" %} +- {% term "Home Assistant Supervised" %} +- {% term "Home Assistant Container" %} + +## Configuration + +This integration is part of the [`default_config`](/integrations/default_config/). + +The following YAML options are available: + +{% configuration %} +debug_ui: + required: false + description: Enables the UI of the go2rtc, which helps debugging WebRTC issues. The `debug_ui` should only be enabled during debugging as it will expose port 1984 without any authentication! + default: false + type: boolean +url: + required: false + description: The URL to the self-hosted [go2rtc](https://github.com/AlexxIT/go2rtc/) server + type: string +{% endconfiguration %} + +{% warning %} + +The `debug_ui` should only be enabled during debugging as it will expose port 1984 without any authentication! +Please disable the `debug_ui` immediately after debugging. + +{% endwarning %} + +### Examples + +Use a self-hosted instance: + +```yaml +go2rtc: + url: http://my-go2rtc-instance:1984 +``` +