Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Fix link to contributing docs, clarify go2rtc config #5076

Closed
wants to merge 1 commit into from

Conversation

JonLaliberte
Copy link

Docs: Fix link to contibuting docs
Docs: Make go2rtc docs a little more clear

Docs: Make go2rtc docs a little more clear
@netlify
Copy link

netlify bot commented Jan 13, 2023

Deploy Preview for frigate-docs ready!

Name Link
🔨 Latest commit 30344f3
🔍 Latest deploy log https://app.netlify.com/sites/frigate-docs/deploys/63c1b097f246300008773287
😎 Deploy Preview https://deploy-preview-5076--frigate-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@JonLaliberte JonLaliberte changed the title Docs: Fix link to contibuting docs, clarify go2rtc config Docs: Fix link to contributing docs, clarify go2rtc config Jan 13, 2023
@@ -21,7 +21,14 @@ webRTC works by creating a websocket connection on extra ports. One of the follo
* Frigate is run with `network_mode: host` to support automatic UDP port pass through locally and remotely. See https://github.com/AlexxIT/go2rtc#module-webrtc for more details
* Frigate is run with `network_mode: bridge` and has:
* Router setup to forward port `8555` to port `8555` on the Frigate device.
* For local webRTC, you will need to create your own go2rtc config:
* Added port to your docker ports list, for example:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to elaborate on this a bit more. Explain that docker users need to map the ports and on the addon side these ports are disabled by default and need to be enabled in the addon config.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually I think we are going to pass 8555 by default since it is not exposing data when not being used


```yaml
volumes:
- /path/to/your/go2rtc.yaml:/config/frigate-go2rtc.yaml:ro
```

See https://github.com/AlexxIT/go2rtc#module-webrtc for more details on configuring go2rtc.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is just for configuring go2rtc then we should link to the repo generally and not the webrtc section

```yaml
ports:
- "5000:5000" # Frigate Web UI
- "8555:8555" # go2rtc
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be updated like the installation docs to pass both 8555 tcp and 8555 udp. Also probably needs to be formatted.

@@ -21,7 +21,14 @@ webRTC works by creating a websocket connection on extra ports. One of the follo
* Frigate is run with `network_mode: host` to support automatic UDP port pass through locally and remotely. See https://github.com/AlexxIT/go2rtc#module-webrtc for more details
* Frigate is run with `network_mode: bridge` and has:
* Router setup to forward port `8555` to port `8555` on the Frigate device.
* For local webRTC, you will need to create your own go2rtc config:
* Added port to your docker ports list, for example:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually I think we are going to pass 8555 by default since it is not exposing data when not being used

@github-actions github-actions bot added the stale label Feb 14, 2023
@github-actions github-actions bot closed this Feb 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants