From aafaddac138ea64bd2347d3eefd27a7bdca58700 Mon Sep 17 00:00:00 2001 From: cyr-ius Date: Mon, 23 Jun 2025 13:04:44 +0200 Subject: [PATCH 1/5] Welcome SFTP Client --- CODEOWNERS | 1 + source/_integrations/sftp_client.markdown | 30 +++++++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 source/_integrations/sftp_client.markdown diff --git a/CODEOWNERS b/CODEOWNERS index 69f8ceef5d9a..6148e824fd19 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -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 diff --git a/source/_integrations/sftp_client.markdown b/source/_integrations/sftp_client.markdown new file mode 100644 index 000000000000..e2d834d3a239 --- /dev/null +++ b/source/_integrations/sftp_client.markdown @@ -0,0 +1,30 @@ +--- +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.2' +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 +--- + +This {% term integration %} allows you to perform Home Assistant backups to a server via SFTP. Once this integration is configured, your server will contain 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. + +## Removing the integration + +{% include integrations/remove_device_service.md %} + +- If you remove the integration, the Assistant Home folder on your server is not automatically deleted. You must delete it manually. + +## Known limitations + +- The integration can only access files that it creates in the Home Assistant folder. It cannot access or modify any other files. + From e334b90e2a17566c7e11a42713e7d1c9b47e631b Mon Sep 17 00:00:00 2001 From: Cyr-ius <1258123+cyr-ius@users.noreply.github.com> Date: Mon, 23 Jun 2025 13:08:45 +0200 Subject: [PATCH 2/5] Update source/_integrations/sftp_client.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- source/_integrations/sftp_client.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/sftp_client.markdown b/source/_integrations/sftp_client.markdown index e2d834d3a239..523b05b1488e 100644 --- a/source/_integrations/sftp_client.markdown +++ b/source/_integrations/sftp_client.markdown @@ -22,7 +22,7 @@ This {% term integration %} allows you to perform Home Assistant backups to a se {% include integrations/remove_device_service.md %} -- If you remove the integration, the Assistant Home folder on your server is not automatically deleted. You must delete it manually. +If you remove the integration, the Home Assistant folder on your server is not automatically deleted. You must delete it manually. ## Known limitations From 6036e5a0248dc61f3e8e53aef0e001e2866dc4b1 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Thu, 26 Jun 2025 06:50:05 +0200 Subject: [PATCH 3/5] Update source/_integrations/sftp_client.markdown --- source/_integrations/sftp_client.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/sftp_client.markdown b/source/_integrations/sftp_client.markdown index 523b05b1488e..d1f1d96dfa97 100644 --- a/source/_integrations/sftp_client.markdown +++ b/source/_integrations/sftp_client.markdown @@ -4,7 +4,7 @@ description: Instructions on how to use SFTP Client in Home Assistant. ha_category: - Backup ha_iot_class: Local Polling -ha_release: '2025.2' +ha_release: '2025.8' ha_config_flow: true ha_domain: sftp_client ha_codeowners: From d3c35129b5170f10ec61dcf0a9d3ef64f49e7111 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Thu, 26 Jun 2025 06:50:59 +0200 Subject: [PATCH 4/5] tiny tweaks --- source/_integrations/sftp_client.markdown | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/source/_integrations/sftp_client.markdown b/source/_integrations/sftp_client.markdown index d1f1d96dfa97..7f15a21f9351 100644 --- a/source/_integrations/sftp_client.markdown +++ b/source/_integrations/sftp_client.markdown @@ -16,7 +16,12 @@ related: title: Creating backups in Home Assistant --- -This {% term integration %} allows you to perform Home Assistant backups to a server via SFTP. Once this integration is configured, your server will contain 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. +The **SFTP Client** {% term integration %} allows you to perform Home Assistant backups to a server via SFTP. 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. + + +## Known limitations + +- The integration can only access files that it creates in the Home Assistant folder. It cannot access or modify any other files. ## Removing the integration @@ -24,7 +29,3 @@ This {% term integration %} allows you to perform Home Assistant backups to a se If you remove the integration, the Home Assistant folder on your server is not automatically deleted. You must delete it manually. -## Known limitations - -- The integration can only access files that it creates in the Home Assistant folder. It cannot access or modify any other files. - From 38c94333d381beab09f3dca5138a2a7bc4351e87 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Thu, 26 Jun 2025 06:52:53 +0200 Subject: [PATCH 5/5] add configuration section --- source/_integrations/sftp_client.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_integrations/sftp_client.markdown b/source/_integrations/sftp_client.markdown index 7f15a21f9351..e24727f899a1 100644 --- a/source/_integrations/sftp_client.markdown +++ b/source/_integrations/sftp_client.markdown @@ -18,6 +18,7 @@ related: The **SFTP Client** {% term integration %} allows you to perform Home Assistant backups to a server via SFTP. 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