Add note that anonymous logins are not supported to mosquitto/DOCS.md #3777
Conversation
…re not supported Reference: home-assistant#2623
![home-assistant[bot]](https://avatars.githubusercontent.com/in/97978?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hi @badbl0cks
It seems you haven't yet signed a CLA. Please do so here.
Once you do that we will be able to review and accept this pull request.
Thanks!
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
home-assistant
bot
added
cla-recheck
cla-signed
and removed
cla-recheck
cla-needed
labels
📝 WalkthroughWalkthroughThe documentation for the Mosquitto add-on has been updated to include a note about login requirements. It clarifies that the add-on does not support anonymous logins, and emphasizes that all connections must be made using a username and password. Additionally, it states that configurations allowing anonymous access, such as Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Mosquitto
User->>Mosquitto: Attempt to connect (anonymous)
Mosquitto-->>User: Connection denied (anonymous logins not supported)
User->>Mosquitto: Attempt to connect (with username/password)
Mosquitto-->>User: Connection successful
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
mosquitto/DOCS.md (1)
71-72: Approve the addition with a minor grammatical improvement.The added note is valuable and aligns well with the PR objectives. It clearly states the login requirements and restrictions of the Mosquitto add-on, which will help prevent user confusion.
Consider this minor grammatical improvement for clarity:
-**Note:** This add-on does not support anonymous logins; all connections must use a username/password to connect. `allow_anonymous true` nor any anonymous ACLs will not work with this add-on. +**Note:** This add-on does not support anonymous logins; all connections must use a username/password to connect. Neither `allow_anonymous true` nor any anonymous ACLs will work with this add-on.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- mosquitto/DOCS.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
mosquitto/DOCS.md (6)
Pattern
*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
Pattern
*/**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern
*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern
*/**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern
*/**(html|markdown|md): do not comment on HTML used for icons
Pattern
*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
Fix documentation to inform users that this HA add-on version of Mosquitto does not support anonymous logins or ACLs. Lost a couple hours of my time wondering why this add-on was silently ignoring configuration options, and thought I'd help others not do the same.
Reference: #2623
Summary by CodeRabbit