From 84da6d38914569c452cd84bb8eb869c4a9ab6342 Mon Sep 17 00:00:00 2001 From: Josef Zweck Date: Sun, 23 Feb 2025 16:27:43 +0100 Subject: [PATCH] Add documentation for backup folder rename to onedrive (#37434) * add documentation for backup folder * tiny tweak * Update onedrive.markdown --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --- source/_integrations/onedrive.markdown | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/source/_integrations/onedrive.markdown b/source/_integrations/onedrive.markdown index 55d88a074c7..9cdd5f4f6d0 100644 --- a/source/_integrations/onedrive.markdown +++ b/source/_integrations/onedrive.markdown @@ -18,7 +18,7 @@ ha_quality_scale: bronze This integration allows you to use [OneDrive](https://www.microsoft.com/en-us/microsoft-365/onedrive/online-cloud-storage) for [Home Assistant Backups](/common-tasks/general/#backups). -Backups will be created in a folder called `Home Assistant\backups_` in the `App Folder` of your OneDrive. +Backups will be created in a folder called `Home Assistant\backups_` in the `App Folder` of your OneDrive by default. `id` is part of your Home Assistant instance's unique id to allow backups from multiple instances to the same OneDrive account. The integration only has access to an application specific `Home Assistant` folder in the `App Folder` and cannot access any other parts of your OneDrive. @@ -32,6 +32,8 @@ Client ID: description: "Application ID of the app registration to be used with the integration. Uses Home Assistant provided by default." Client secret: description: "Application secret for the app registration. Uses Home Assistant provided by default." +Folder name: + description: "The name of the instance specific [backup folder](#backup-folder)." {% endconfiguration_basic %} @@ -42,6 +44,12 @@ Delete files permanently: description: By default, files are put into the Recycle Bin when deleted, where they remain available for another 30 days. If you enable this option, files will be deleted immediately when they are cleaned up by the backup system. {% endconfiguration_basic %} +## Backup folder + +The backup folder is `root:\Apps\[Home Assistant | Graph]\backups_{id}`. This is not configurable because otherwise the integration would need permissions to write into your entire drive. You can, however, rename the application folder which is called `Home Assistant` or `Graph` in your OneDrive. + +The last folder in the hierarchy (`backups_{id}`) is always a unique folder per Home Assistant instance to ensure that backups from different instances are not mixed. The name of this folder can be set during integration setup and can be changed later through reconfiguring the integration or by renaming the folder OneDrive. + ## Requested permissions by the integration The integration will request the following permissions on your OneDrive for the integration to work: @@ -53,7 +61,6 @@ The integration will request the following permissions on your OneDrive for the Lists of permissions that the application will request. - ## Getting application credentials This integration comes with a predefined set of [application credentials](https://www.home-assistant.io/integrations/application_credentials/) through Home Assistant account linking.