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

Open
wants to merge 5 commits into
base: next
Choose a base branch
from
Open

Welcome SFTP Client #39676

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
aafadda
Welcome SFTP Client
cyr-ius Jun 23, 2025
e334b90
Update source/_integrations/sftp_client.markdown
cyr-ius Jun 23, 2025
6036e5a
Update source/_integrations/sftp_client.markdown
c0ffeeca7 Jun 26, 2025
d3c3512
tiny tweaks
c0ffeeca7 Jun 26, 2025
38c9433
add configuration section
c0ffeeca7 Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CODEOWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -805,6 +805,7 @@ source/_integrations/serial.markdown @fabaff
source/_integrations/seven_segments.markdown @fabaff
source/_integrations/seventeentrack.markdown @shaiu
source/_integrations/sfr_box.markdown @epenet
source/_integrations/sftp_client.markdown @cyr-ius
source/_integrations/sharkiq.markdown @JeffResc @funkybunch
source/_integrations/shell_command.markdown @home-assistant/core
source/_integrations/shelly.markdown @balloob @bieniu @thecode @chemelli74 @bdraco
Expand Down
32 changes: 32 additions & 0 deletions source/_integrations/sftp_client.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: SFTP Client
description: Instructions on how to use SFTP Client in Home Assistant.
ha_category:
- Backup
ha_iot_class: Local Polling
ha_release: '2025.8'
ha_config_flow: true
ha_domain: sftp_client
ha_codeowners:
- '@cyr-ius'
ha_integration_type: service
ha_quality_scale: platinum
related:
- docs: /common-tasks/general/#backups
title: Creating backups in Home Assistant
---

The **SFTP Client** {% term integration %} allows you to perform Home Assistant backups to a server via <abbr title="secure file transfer protocol">SFTP</abbr>. Once this integration is configured, your server contains a new folder called backup where all backups will be stored. If you delete the folder, it will be automatically recreated as long as the {% term integration %} is enabled.

{% include integrations/config_flow.md %}

## Known limitations

- The integration can only 5A9A access files that it creates in the Home Assistant folder. It cannot access or modify any other files.

## Removing the integration

{% include integrations/remove_device_service.md %}

If you remove the integration, the Home Assistant folder on your server is not automatically deleted. You must delete it manually.

0