diff --git a/source/_includes/common-tasks/third-party-addons.md b/source/_includes/common-tasks/third-party-addons.md index 827791fbfce..6c984c52ed8 100644 --- a/source/_includes/common-tasks/third-party-addons.md +++ b/source/_includes/common-tasks/third-party-addons.md @@ -1,25 +1,32 @@ -## Installing third-party add-ons +## Installing a third-party add-on repository -Home Assistant allows anyone to create add-on repositories to share their add-ons easily. To try this locally, you can use our example add-on repository at +Home Assistant allows anyone to create an add-on repository to share their own add-ons with the community. -```text -https://github.com/home-assistant/hassio-addons-example -``` - -{% caution %} +{% warning %} Home Assistant cannot guarantee the quality or security of third-party add-ons. Use at your own risk. -{% endcaution %} +{% endwarning %} -

- -From {% my supervisor title="Settings > Add-ons" %} open the add-on store. -

+To add an add-on repository, follow these steps: -

- -Add the URL of the repository and then press "Add". A new card for the repository will appear. -

+1. Copy the URL of the repository. + - The URL is simply the git repository clone URL (on GitHub, use the Code button and copy the https/web URL). + - This documentation uses our example add-on repository, which is not really practically useful but follows the same steps. If you are interested in add-on development, refer to our [add-on development documentation](https://developers.home-assistant.io/docs/add-ons). -### Help: Repository is not showing up + ```text + https://github.com/home-assistant/hassio-addons-example + ``` +2. Go to {% my supervisor title="**Settings** > **Add-ons**" %} and select **Add-on store**. + ![Screenshot of the add-on store](/images/getting-started/add-ons.png) +3. In the top-right corner, select the three dots {% icon "mdi:dots-vertical" %} menu, and select **Repositories**. +4. Add the URL of the repository and select **Add**. + ![Screenshot of the add-on store](/images/hassio/screenshots/adding_repositories.png) + - **Result**: A new card for the repository will appear. + ![Screenshot of the add-on store](/images/hassio/screenshots/add-ons-community_example.png) -If you have added a repository, but it's not showing up, it means that the repository contains invalid configuration. Go to {% my logs title="Settings > System > Logs" %} to find the System log. It should tell you what went wrong. Report this information to the repository author. +### Troubleshooting: Repository is not showing up + +If you have added an add-on repository, but it's not showing up, make sure to refresh your browser. If it still doesn't show up, the add-on repository may contain invalid configuration data. + +1. Go to {% my logs title="**Settings** > **System** > **Logs**" %} and select Supervisor in the top right corner to get the Supervisor log. + - It should tell you what went wrong. +2. Report this information to the add-on repository author. diff --git a/source/images/hassio/screenshots/add-ons-community_example.png b/source/images/hassio/screenshots/add-ons-community_example.png new file mode 100644 index 00000000000..92044534ba9 Binary files /dev/null and b/source/images/hassio/screenshots/add-ons-community_example.png differ diff --git a/source/images/hassio/screenshots/adding_repositories.png b/source/images/hassio/screenshots/adding_repositories.png index 09fd9e2ce15..dd9a05fc386 100644 Binary files a/source/images/hassio/screenshots/adding_repositories.png and b/source/images/hassio/screenshots/adding_repositories.png differ diff --git a/source/images/hassio/screenshots/dashboard.png b/source/images/hassio/screenshots/dashboard.png deleted file mode 100644 index bd8f2ec9576..00000000000 Binary files a/source/images/hassio/screenshots/dashboard.png and /dev/null differ