installing an add-on repository: update (#34115)

* installing an add-on repository: update

- update screenshots
- rephrase to make it more clear that this is about add-on repositories
  - and not about installing an add-on from the official add-on store
- style tweaks

* Fix screenshot

* Fix typo

* Update source/_includes/common-tasks/third-party-addons.md

Co-authored-by: Stefan Agner <stefan@agner.ch>

* Apply suggestions from code review

Co-authored-by: Stefan Agner <stefan@agner.ch>

* Apply suggestions from code review

Co-authored-by: Stefan Agner <stefan@agner.ch>

---------

Co-authored-by: Stefan Agner <stefan@agner.ch>
This commit is contained in:
c0ffeeca7 2024-08-05 10:06:18 +02:00 committed by GitHub
parent 47111c7a33
commit c1e2cb96da
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 25 additions and 18 deletions

View File

@ -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 %}
<p class='img'>
<img src='/images/hassio/screenshots/dashboard.png' />
From {% my supervisor title="Settings > Add-ons" %} open the add-on store.
</p>
To add an add-on repository, follow these steps:
<p class='img'>
<img src='/images/hassio/screenshots/adding_repositories.png' />
Add the URL of the repository and then press "Add". A new card for the repository will appear.
</p>
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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 134 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB