Update CIFS Authentication Documentation #36767
Conversation
Update network_storage.md
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request introduces a minor documentation update in the network storage configuration section. Specifically, the description for the "[CIFS]2 Username" field has been enhanced with additional guidance about using the User Principal Name for domain accounts. This change aims to provide more precise instructions for users configuring network storage connections. Changes
Note: No structural changes or modifications to exported/public entities were made in this update. 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
🧹 Nitpick comments (1)
source/_includes/common-tasks/network_storage.md (1)
59-59: LGTM! Clear and helpful addition.The added clarification about using User Principal Name (UPN) format for domain accounts is valuable. This will help users avoid authentication issues when connecting to Active Directory domain shares.
Consider adding an example for clarity.
To make this even more helpful, consider adding an example of the UPN format, like:
- description: The username to use when connecting to the storage server. Use User Principal Name for domain accounts. + description: The username to use when connecting to the storage server. Use User Principal Name for domain accounts (e.g., [email protected]).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_includes/common-tasks/network_storage.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
| @@ -56,7 +56,7 @@ Server: | |||
| "[NFS]<sup>1</sup> Remote share path": | |||
| description: The path used to connect to the remote storage server. | |||
| "[CIFS]<sup>2</sup> Username": | |||
| description: The username to use when connecting to the storage server. | |||
| description: The username to use when connecting to the storage server. Use User Principal Name for domain accounts. | |||
There was a problem hiding this comment.
could you add an example?
|
I'm drafting this PR, as changes are needed. Please undraft it, once the changes have been implemented and the PR is ready for review again. |
Proposed change
Clarified the correct username format for adding CIFS shares connected to an Active Directory Domain.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit