-
-
Notifications
You must be signed in to change notification settings - Fork 7.8k
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
base: next
Are you sure you want to change the base?
IDrive e2 backup documentation #40499
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
## 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** |
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.
## 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
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.
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?
|
||
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" %} |
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.
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?
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.
I used the AWS S3 documentation as a starting point and there this sentence is also added. The IDrive e2 functionality is closely related.
If needed:
IDrive e2 has a tutorial section where we also could refer to.
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
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
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit