jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for backup folder rename to onedrive (#37434)

Browse Source 
* add documentation for backup folder

* tiny tweak

* Update onedrive.markdown

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Josef Zweck 2025-02-23 16:27:43 +01:00 committed by GitHub
parent 8e135086d7
commit 84da6d3891
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
source/_integrations/onedrive.markdown
View File

@ -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). 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_<id>` in the `App Folder` of your OneDrive. Backups will be created in a folder called `Home Assistant\backups_<id>` 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. `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. 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." description: "Application ID of the app registration to be used with the integration. Uses Home Assistant provided by default."
Client secret: Client secret:
description: "Application secret for the app registration. Uses Home Assistant provided by default." 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 %} {% 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. 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 %} {% 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 ## Requested permissions by the integration
The integration will request the following permissions on your OneDrive for the integration to work: 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
<img src='/images/integrations/onedrive/onedrive-permissions.png' alt='Lists of permissions that the application will request.'> <img src='/images/integrations/onedrive/onedrive-permissions.png' alt='Lists of permissions that the application will request.'>
## Getting application credentials ## 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. This integration comes with a predefined set of [application credentials](https://www.home-assistant.io/integrations/application_credentials/) through Home Assistant account linking.