mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-29 14:26:50 +00:00
870637a7dc
Clarified that you MUST define the `certificate` parameter to enable TLS connections to the MQTT server. This was not clear to me and was fighting with getting the right PEM/CRT file setup as commections were failing. When I then selected 'auto' it worked as designed. It would be better if there was an 'enable_tls' config parameter that would enable it and default to 'auto', but that;s a code change.
31 lines
1.3 KiB
Markdown
31 lines
1.3 KiB
Markdown
---
|
|
title: "MQTT Certificate"
|
|
description: "Instructions on how to setup MQTT with a certificate in Home Assistant."
|
|
logo: mqtt.png
|
|
---
|
|
|
|
Using certificates will give you an additional layer of security for your MQTT communication.
|
|
|
|
To integrate MQTT with certificate into Home Assistant, add the following section to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
mqtt:
|
|
certificate: /home/paulus/dev/addtrustexternalcaroot.crt
|
|
```
|
|
|
|
{% configuration %}
|
|
certificate:
|
|
description: "'auto' or the certificate authority certificate file that is to be treated as trusted by this client. To enable a secure (TLS) connection to your server you must define the 'certitificate' configuration parameter. 'auto' uses the certifite CAs bundled certificates. If a file is specified the file should contain the root certificate of the certificate authority that signed your broker's certificate, but may contain multiple certificates. Example: `/home/user/identrust-root.pem`."
|
|
required: false
|
|
type: string
|
|
client_key:
|
|
description: Client key, e.g., `/home/user/owntracks/cookie.key`.
|
|
required: false
|
|
type: string
|
|
client_cert:
|
|
description: Client certificate, e.g., `/home/user/owntracks/cookie.crt`.
|
|
required: false
|
|
type: string
|
|
{% endconfiguration %}
|