8000 Welcome SFTP Client by cyr-ius · Pull Request #39676 · home-assistant/home-assistant.io · GitHub
[go: up one dir, main page]
Skip to content

Welcome SFTP Client #39676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: next
Choose a base branch
from
Open

Welcome SFTP Client #39676

wants to merge 2 commits into from

Conversation

cyr-ius
Copy link
Contributor
@cyr-ius cyr-ius commented Jun 23, 2025 •
edited by coderabbitai bot
Loading

Proposed change

SFTP Client allows you to specify an SFTP source to perform Home Assistant backups

PR for new integration : home-assistant/core#147300
Brands: home-assistant/brands#7312

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).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

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

Summary by CodeRabbit

  • New Features
    • Added documentation for the new "SFTP Client" integration, enabling Home Assistant backups to a remote server via SFTP.
  • Chores
    • Assigned ownership of the SFTP Client integration documentation to @cyr-ius.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Jun 23, 2025
@netlify Netlify
Copy link
netlify bot commented Jun 23, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit e334b90
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/685935c0df45f60008e755a5
😎 Deploy Preview https://deploy-preview-39676--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

This was referenced Jun 23, 2025
Open
Open
@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Jun 23, 2025 •
edited
Loading
📝 Walkthrough

Walkthrough

A new documentation file for the SFTP Client integration in Home Assistant was added, detailing its functionality for backing up data to a remote server via SFTP. The CODEOWNERS file was updated to assign responsibility for this documentation file to the user @cyr-ius. No changes to code or public APIs were made.

Changes

File(s) Change Summary
source/_integrations/sftp_client.markdown Added documentation for the new SFTP Client integration, including usage, limitations, and metadata.
CODEOWNERS Assigned ownership of the new documentation file to @cyr-ius.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant SFTPServer

    User->>HomeAssistant: Configure SFTP Client integration
    HomeAssistant->>SFTPServer: Connect and create "backup" folder (if not exists)
    HomeAssistant->>SFTPServer: Upload backup files to "backup" folder
    Note over SFTPServer: If "backup" folder deleted, HomeAssistant recreates it
    User->>HomeAssistant: Remove integration (optional)
    Note over User, SFTPServer: "backup" folder remains unless manually deleted
Loading
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between aafadda and e334b90.

📒 Files selected for processing (1)
  • source/_integrations/sftp_client.markdown (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/sftp_client.markdown
⏰ 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

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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[bot]
coderabbitai bot reviewed Jun 23, 2025
View reviewed changes
Copy link
Contributor
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
source/_integrations/sftp_client.markdown (1)

3-3: Remove extra space in description

There are two spaces before “SFTP Client” in the description. Please remove the extra space for consistency.

Example diff:

-description: Instructions on how to use  SFTP Client in Home Assistant.
+description: Instructions on how to use SFTP Client in Home Assistant.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between bd9aa54 and aafadda.

📒 Files selected for processing (2)
  • CODEOWNERS (1 hunks)
  • source/_integrations/sftp_client.markdown (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
🔇 Additional comments (1)
CODEOWNERS (1)

808-808: Confirm ownership entry placement and formatting

The new entry for source/_integrations/sftp_client.markdown is correctly added and alphabetically positioned between sfr_box.markdown and sharkiq.markdown. Assigning @cyr-ius is consistent with the PR objectives.

@cyr-ius @coderabbitai
Update source/_integrations/sftp_client.markdown
e334b90 
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@cyr-ius
0