Files
hassio-addons/addons_updater/README.md
2021-12-27 23:52:59 +01:00

84 lines
3.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Home assistant add-on: addons updater
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
[![Support Thread][support-badge]](https://community.home-assistant.io/t/new-addon-automatically-update-addons-based-on-github-upstream-new-releases/)
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
[support-badge]: https://camo.githubusercontent.com/f4dbb995049f512fdc97fcc9e022ac243fa38c408510df9d46c7467d0970d959/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f537570706f72742d7468726561642d677265656e2e737667
![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Faddons_updater%2Fconfig.json)
![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Faddons_updater%2Fconfig.json)
![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Faddons_updater%2Fconfig.json)
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
[![Stargazers repo roster for @alexbelgium/hassio-addons](https://reporoster.com/stars/alexbelgium/hassio-addons)](https://github.com/alexbelgium/hassio-addons/stargazers)
## About
This script allows to automatically update addons based on upstream new releases. This is only an helper tool for developers. End users dont need that to update their addons - they are automatically alerted by HA when an update is available
## Installation
The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Hass.io add-on.
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance.
1. Install this add-on.
1. Click the `Save` button to store your configuration.
1. Make sure that the two ports are open on your router
1. Start the add-on.
1. Check the logs of the add-on to see if everything went well.
1. Carefully configure the add-on to your preferences, see the official documentation for for that.
## Configuration
No webUI. Set everything through configuration.
```yaml
addon:
- slug: the slug name from your repo
beta: true/false ; should it look only for releases or prereleases ok
fulltag: true is for example "v3.0.1-ls67" false is "3.0.1"
repository: 'name/repo' coming from github
upstream: name/repo, example is 'linuxserver/docker-emby'
source : github or dockerhub
gituser: your github username
gitpass: your github password
gitmail: your github email
verbose: 'false'
gitapi: optional, it is the API key from your github repo
```
Example:
```yaml
addon:
- slug: sonarr
beta: false
fulltag: false
repository: alexbelgium/hassio-addons
upstream: linuxserver/docker-sonarr
- slug: transmission
beta: false
fulltag: true
repository: alexbelgium/hassio-addons
upstream: linuxserver/docker-transmission
- slug: ubooquity
beta: false
fulltag: false
repository: alexbelgium/hassio-addons
upstream: linuxserver/docker-ubooquity
gituser: your github username
gitpass: your github password
gitmail: your github email
verbose: 'false'
```
[repository]: https://github.com/alexbelgium/hassio-addons
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg