Add websockets transport mechanism to MQTT #15600
Labels
enhancement
New feature or request
Comments
|
Is there a reason why you didn't create this as a PR? |
|
I tried to do a PR first, I am using Jetbrains Pycharm and got denied. Request response: Access to site has been restricted. |
|
You need to push to your fork and then create a PR from the fork to frigate. Can be done in the github ui. |
VideoCurio
added a commit
to VideoCurio/frigate
that referenced
this issue
Dec 19, 2024
## Proposed change Add websockets transport mechanism to MQTT. An MQTT server is not always reachable only as raw TCP on port 1881; it can also be accessed as a WebSocket server, sometimes even behind a reverse proxy with TLS. Paho MQTT supports this feature, as does Mosquitto. The default transport option was set to 'tcp', so this change will not affect an already configured Frigate app. The configuration change is validated using a call to a pydantic library field validator. This patch has been tested with Mosquitto 1.6 and 2.0, as well as with a server behind a reverse proxy on port 443 (requiring a TLS connection). The docs/configuration/reference.md file has also been updated to reflect this change. ## Type of change - [ ] Dependency upgrade - [ ] Bugfix (non-breaking change which fixes an issue) - [x] New feature - [ ] Breaking change (fix/feature causing existing functionality to break) - [ ] Code quality improvements to existing code - [x] Documentation Update ## Additional information - This PR fixes or closes issue: fixes blakeblackshear#15600 - This PR is related to issue: ## Checklist - [x] The code change is tested and works locally. - [ ] Local tests pass. **Your PR cannot be merged unless tests pass** - [x] There is no commented out code in this PR. - [x] The code has been formatted using Ruff (`ruff format frigate`)
10 tasks
|
Ok PR published. Thanks @NickM-27 for the advice. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe what you are trying to accomplish and why in non technical terms
Add a websockets transport option for MQTT.
Describe the solution you'd like
An MQTT server is not always reachable only as raw TCP on port 1881; it can also be accessed as a WebSocket server, sometimes even behind a reverse proxy with TLS. Paho MQTT supports this feature, as does Mosquitto.
Describe alternatives you've considered
Additional context
I have write a patch that solve this: Add_websockets_transport_mechanism_to_MQTT_.patch.txt. The default transport option was set to 'tcp', so this change will not affect an already configured Frigate app.
The configuration change is validated using a call to a pydantic library field validator.
This patch has been tested with Mosquitto 1.6 and 2.0, as well as with a server behind a reverse proxy on port 443 (requiring a TLS connection).
The docs/configuration/reference.md file has also been updated to reflect this change.
Type of change
Additional information
Checklist
ruff format frigate)The text was updated successfully, but these errors were encountered: