mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-10 09:51:02 +01:00
105 lines
5.8 KiB
Markdown
105 lines
5.8 KiB
Markdown
|
||
# Home assistant add-on: addons updater
|
||
|
||
|
||
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons
|
||
|
||
If this add-on saves you time or makes your setup easier, I would be very grateful for your support!
|
||
|
||
[![Buy me a coffee][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
||
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
||
|
||
## Addon informations
|
||
|
||
|
||
|
||
|
||
|
||
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
||
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
||
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
||
|
||
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
||
[paypal-badge]: https://img.shields.io/badge/Donate%20via%20PayPal-0070BA?logo=paypal&style=flat&logoColor=white
|
||
|
||
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
||
|
||
[](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 don’t 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. Configure the add-on to your preferences, see below
|
||
1. Click the `Save` button to store your configuration.
|
||
1. Start the add-on.
|
||
1. Check the logs of the add-on to see if everything went well.
|
||
|
||
## Configuration
|
||
|
||
No webUI. Configuration is set in 2 ways.
|
||
|
||
### Updater.json
|
||
|
||
In the addon folder of your repository (where is located you config.json), create a "updater.json" file.
|
||
This file will be used by the addon to fetch the addon upstream informations.
|
||
Only addons with an updater.json file will be updated.
|
||
Here is [an example](https://github.com/alexbelgium/hassio-addons/blob/master/arpspoof/updater.json).
|
||
|
||
You can add the following tags in the file :
|
||
|
||
- github_fulltag: true is for example "v3.0.1-ls67" false is "3.0.1"
|
||
- github_beta: true/false ; should it look only for releases or prereleases ok
|
||
- github_havingasset : true if there is a requirement that a release has binaries and not just source
|
||
- github_tagfilter: filter a text in the release name
|
||
- github_exclude: exclude a text in the release name
|
||
- last_update: automatically populated, date of last upstream update
|
||
- repository: 'name/repo' coming from github
|
||
- paused: true # Pauses the updates
|
||
- slug: the slug name from your addon
|
||
- source: dockerhub/github,gitlab,bitbucket,pip,hg,sf,website-feed,local,helm_chart,wiki,system,wp
|
||
- upstream_repo: name/repo, example is 'linuxserver/docker-emby'
|
||
- upstream_version: automatically populated, corresponds to the current upstream version referenced in the addon
|
||
- dockerhub_by_date: in dockerhub, uses the last_update date instead of the version
|
||
- dockerhub_list_size: in dockerhub, how many containers to consider for latest version
|
||
|
||
### Addon configuration
|
||
|
||
Here you define the values that will allow the addon to connect to your repository.
|
||
|
||
```yaml
|
||
repository: 'name/repo' coming from github
|
||
gituser: your github username
|
||
gitapi: your github api token(classic) https://github.com/settings/tokens
|
||
gitmail: your github email
|
||
verbose: 'false'
|
||
```
|
||
|
||
Example:
|
||
|
||
```yaml
|
||
repository: alexbelgium/hassio-addons
|
||
gituser: your github username
|
||
gitapi: your github api token
|
||
gitmail: your github email
|
||
verbose: "false"
|
||
```
|
||
|
||
### Custom Scripts and Environment Variables
|
||
|
||
This addon supports custom scripts and environment variables through the `addon_config` mapping:
|
||
|
||
- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
|
||
- **Environment variables**: Use the add-on `env_vars` option and see [Add Environment Variables to your Addon](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon) for details.
|
||
|
||
[repository]: https://github.com/alexbelgium/hassio-addons
|