Skip to content

IDrive e2 backup documentation #40499

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

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

Conversation

patrickvorgers
Copy link

Proposed change

This is the documentation for the proposed IDrive e2 backup provider. As discussed earlier each S3 implementation should have their own implementation. This implementation for instance uses a specific config_flow for IDrive e2 which automatically determines the endpoint based on the provided credentials and provides the user a dropdown selection box to select the bucket.

ps: As requested a new PR

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive setup and configuration instructions for integrating IDrive e2 as a backup location in Home Assistant, including security best practices and step-by-step guides for bucket and access key creation.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in another repo next This PR goes into the next branch labels Aug 18, 2025
Copy link

netlify bot commented Aug 18, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 01b2354
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/68a3423ec3d2730008d0deed
😎 Deploy Preview https://deploy-preview-40499--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@c0ffeeca7 c0ffeeca7 added the new-integration This PR adds documentation for a new Home Assistant integration label Aug 18, 2025
Comment on lines +76 to +85
## Setting up the IDrive e2 integration in Home Assistant

1. In Home Assistant, go to **Settings > Devices & Services**.
1. Click **Add Integration** and search for **IDrive e2**.
1. Enter the following details:
- Access Key ID and Secret Access Key
1. Click **Submit**
- The integration tests the connection, determines the endpoint, and retrieves available buckets.
1. Select the name of the bucket from the dropdown list
1. Click **Submit**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Setting up the IDrive e2 integration in Home Assistant
1. In Home Assistant, go to **Settings > Devices & Services**.
1. Click **Add Integration** and search for **IDrive e2**.
1. Enter the following details:
- Access Key ID and Secret Access Key
1. Click **Submit**
- The integration tests the connection, determines the endpoint, and retrieves available buckets.
1. Select the name of the bucket from the dropdown list
1. Click **Submit**

This is covered by the config flow

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used the AWS S3 documentation as a starting point and there these steps are also included. The IDrive e2 functionality is closely related. How to proceed?

AWS S3 documentation


This integration requires an existing IDrive e2 bucket and an Access Key with permissions to that bucket. For security reasons, it is strongly recommended to scope the Access Key policy as narrowly as possible to the required operations and resources only.

{% details "Create a new IDrive e2 bucket" %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

documenting the IDrive side of things is a bit out of scope for Home Assistant documentation. Is there IDrive documentation we can link to instead?

Copy link
Author

@patrickvorgers patrickvorgers Aug 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used the AWS S3 documentation as a starting point and there this sentence is also added. The IDrive e2 functionality is closely related.

AWS S3 documentation

If needed:
IDrive e2 has a tutorial section where we also could refer to.

@home-assistant home-assistant bot marked this pull request as draft August 18, 2025 13:55
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

patrickvorgers and others added 3 commits August 18, 2025 15:57
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
@patrickvorgers patrickvorgers marked this pull request as ready for review August 19, 2025 16:53
@home-assistant home-assistant bot requested a review from c0ffeeca7 August 19, 2025 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has-parent This PR has a parent PR in another repo new-integration This PR adds documentation for a new Home Assistant integration next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants