frigate/docs
VideoCurio 56a128b776 Add websockets transport mechanism to MQTT
## 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 #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`)
2024-12-19 17:29:10 +01:00
..
docs Add websockets transport mechanism to MQTT 2024-12-19 17:29:10 +01:00
plugins docs: include available objects in documentation 2021-03-09 06:23:37 -06:00
src/css Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
static Api improvements (#15327) 2024-12-06 08:04:02 -06:00
.gitignore docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
babel.config.js docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
docusaurus.config.ts Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
package-lock.json Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
package.json Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
README.md Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
sidebars.ts Docs: correct go2rtc version used (#14753) 2024-11-03 05:16:59 -07:00

Website

This website is built using Docusaurus 3.5, a modern static website generator.

For installation and contributing instructions, please follow the Contributing Docs.

Development

  1. Run npm i to install dependencies
  2. Run npm run start to start the website