-
-
Notifications
You must be signed in to change notification settings - Fork 7.4k
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.
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
Add documentation for OneDrive #36768
Open
zweckj
wants to merge
6
commits into
home-assistant:next
Choose a base branch
from
zweckj:onedrive/init
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
feac41b
Create onedrive.markdown
zweckj 25faeee
Fix typos and improve clarity in documentation
zweckj 05f1cc2
Fix typos and improve clarity in documentation
zweckj cb7b3c9
Add newline in OneDrive integration markdown
zweckj ed34313
Update OneDrive integration documentation
zweckj e1c8f83
Fix grammar in OneDrive integration permissions
zweckj File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
--- | ||
title: OneDrive | ||
description: Instructions on how to setup OneDrive to be used with backups. | ||
ha_release: 2025.2 | ||
ha_category: | ||
- Backup | ||
ha_iot_class: Cloud Polling | ||
ha_config_flow: true | ||
ha_domain: onedrive | ||
ha_codeowners: | ||
- '@zweckj' | ||
ha_integration_type: service | ||
--- | ||
|
||
This integration allows you to use [OneDrive](https://www.microsoft.com/en-us/microsoft-365/onedrive/online-cloud-storage) for use with Home Assistant Backups. | ||
|
||
Backups will be created in a folder called `home-assistant\backups` in the `App Folder` of your OneDrive. | ||
The integration only has access to a application specific `home-assistant` folder in the `App Folder` and cannot access any other parts of your OneDrive. | ||
|
||
{% include integrations/config_flow.md %} | ||
{% configuration_basic %} | ||
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." | ||
|
||
{% endconfiguration_basic %} | ||
|
||
{% include integrations/option_flow.md %} | ||
|
||
## Requested permissions by the integration | ||
|
||
The integration will request the following permissions on your OneDrive for the integration to work: | ||
|
||
- `Files.ReadWrite.AppFolder`: Grants the application permission to read and write in its own, app-specific folder inside your OneDrive | ||
- `offline_access`: Grants the application permission to refresh its authentication token without requiring your manual intervention | ||
- `openid`: Grants the application permission to read basic information, e.g. if you have a OneDrive | ||
|
||
## 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. | ||
Everything is done in a delegated user context, so nobody will ever have access to your data except you. However, if you want to use your own credentials, | ||
follow [this guide](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate) to create your own client ID and secret. | ||
|
||
{% note %} | ||
You will need an Azure tenant with an active Azure subscription to create your own client credentials. | ||
{% endnote %} | ||
|
||
## Known Limitations | ||
|
||
- Only personal OneDrives are supported at the moment | ||
|
||
## Removing the integration | ||
|
||
This integration follows standard integration removal. No extra steps are required. | ||
|
||
{% include integrations/remove_device_service.md %} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Fix grammatical error
Use "an" instead of "a" before "application".
📝 Committable suggestion
🧰 Tools
🪛 LanguageTool
[misspelling] ~18-~18: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ive. The integration only has access to a application specific
home-assistant
f...(EN_A_VS_AN)