Update CIFS Authentication Documentation #36767

HartD92 · 2025-01-06T17:30:40Z

Proposed change

Clarified the correct username format for adding CIFS shares connected to an Active Directory Domain.

Type of change

Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration I'm adding to Home Assistant (next branch).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase:
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

Checklist

This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the current branch.
- I made a change that is related to an upcoming version of Home Assistant and used the next branch.
The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Documentation
- Updated description for CIFS Username field to clarify username format for domain accounts.
- Provided guidance on using User Principal Name when configuring network storage connections.

Update network_storage.md

netlify · 2025-01-06T17:31:08Z

❌ Deploy Preview for home-assistant-docs failed.

Name	Link
🔨 Latest commit	`c854eaf`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/6790a8defc4a1e00087d1ab8

coderabbitai · 2025-01-06T17:32:31Z

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The pull request introduces a minor documentation update in the network storage configuration section. Specifically, the description for the "[CIFS]² Username" field has been enhanced with additional guidance about using the User Principal Name for domain accounts. This change clarifies the expected format for usernames associated with domain accounts, enhancing user understanding of the configuration requirements for CIFS connections.

Changes

File	Change Summary
`source/_includes/common-tasks/network_storage.md`	Updated username field description to specify using User Principal Name for domain accounts

Note: No structural changes or modifications to exported/public entities were made in this update.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6c19cab and c854eaf.

📒 Files selected for processing (1)

source/_includes/common-tasks/network_storage.md (1 hunks)

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?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

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

📥 Commits

Reviewing files that changed from the base of the PR and between aa0a538 and 33d9c75.

📒 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

c0ffeeca7 · 2025-01-07T08:23:55Z

source/_includes/common-tasks/network_storage.md

@@ -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.


could you add an example?

c0ffeeca7 · 2025-01-07T09:24:26Z

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.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

source/_includes/common-tasks/network_storage.md (1)
59-59: Consider clarifying local vs domain account formats.

To make the documentation even more comprehensive, consider adding information about local account format:
- description: The username to use when connecting to the storage server. Use User Principal Name for domain accounts. (ex. [email protected])
+ description: The username to use when connecting to the storage server. For Active Directory domain accounts, use User Principal Name format (ex. [email protected]). For local accounts, use the local username (ex. localuser).
🧰 Tools

🪛 Markdownlint (0.37.0)

59-59: null
Bare URL used

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 33d9c75 and 6c19cab.

📒 Files selected for processing (1)

source/_includes/common-tasks/network_storage.md (1 hunks)

🧰 Additional context used

🪛 Markdownlint (0.37.0)

source/_includes/common-tasks/network_storage.md

59-59: null
Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (1)

source/_includes/common-tasks/network_storage.md (1)

59-59: Great improvement to the documentation!

The addition of the User Principal Name format with an example significantly improves clarity for users setting up domain authentication.

🧰 Tools

🪛 Markdownlint (0.37.0)

59-59: null
Bare URL used

(MD034, no-bare-urls)

source/_includes/common-tasks/network_storage.md

c0ffeeca7

Thank you, @HartD92 👍

HartD92 added 2 commits January 6, 2025 10:27

Update network_storage.md

a796f7a

Merge pull request #1 from HartD92/cifs-domain-account

33d9c75

Update network_storage.md

home-assistant bot added the current This PR goes into the current branch label Jan 6, 2025

coderabbitai bot reviewed Jan 6, 2025

View reviewed changes

c0ffeeca7 reviewed Jan 7, 2025

View reviewed changes

c0ffeeca7 marked this pull request as draft January 7, 2025 09:24

Update network_storage.md

dc56359

HartD92 marked this pull request as ready for review January 21, 2025 23:06

Merge branch 'current' into current

6c19cab

coderabbitai bot reviewed Jan 21, 2025

View reviewed changes

c0ffeeca7 reviewed Jan 22, 2025

View reviewed changes

source/_includes/common-tasks/network_storage.md Outdated Show resolved Hide resolved

tiny tweak

c854eaf

c0ffeeca7 approved these changes Jan 22, 2025

View reviewed changes

c0ffeeca7 merged commit 2df962d into home-assistant:current Jan 22, 2025
2 of 7 checks passed

frenck mentioned this pull request Jan 22, 2025

Fix website builds #37057

Merged

8 tasks

github-actions bot locked and limited conversation to collaborators Jan 23, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Update CIFS Authentication Documentation #36767

Update CIFS Authentication Documentation #36767

Uh oh!

HartD92 commented Jan 6, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

netlify bot commented Jan 6, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jan 6, 2025 •

edited

Loading

Review failed

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

c0ffeeca7 Jan 7, 2025

Uh oh!

c0ffeeca7 commented Jan 7, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

c0ffeeca7 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Update CIFS Authentication Documentation #36767

Update CIFS Authentication Documentation #36767

Uh oh!

Conversation

HartD92 commented Jan 6, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Uh oh!

netlify bot commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ Deploy Preview for home-assistant-docs failed.

Uh oh!

coderabbitai bot commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

c0ffeeca7 Jan 7, 2025

Choose a reason for hiding this comment

Uh oh!

c0ffeeca7 commented Jan 7, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

c0ffeeca7 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

HartD92 commented Jan 6, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Jan 6, 2025 •

edited

Loading

coderabbitai bot commented Jan 6, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)