jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 09:46:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update add-on publishing

Browse Source
This commit is contained in:
Paulus Schoutsen 2017-05-14 15:52:46 -07:00
parent 2b6b2534a4
commit e1a59aed04
3 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_includes/asides/hassio_navigation.html
View File

@ -6,7 +6,6 @@
{% active_link /hassio/ Hass.io %}
<ul>
<li>{% active_link /hassio/installation/ Installation %}</li>
<li>{% active_link /hassio/debugging/ Debugging %}</li>
<li>{% active_link /addons/ Available add-ons %}</li>
<li>{% active_link /hassio/installing_third_party_addons/ Installing third-party add-ons %}</li>
<li>{% active_link /hassio/architecture/ Architecture %}</li>
@ -24,6 +23,7 @@
<li>{% active_link /hassio/addon_repository/ Repositories %}</li>
</ul>
</li>
<li>{% active_link /hassio/debugging/ Debugging Hass.io %}</li>
</ul>
</div>
</section>

24
source/hassio/addon_publishing.markdown
View File

@ -9,17 +9,35 @@ sharing: true
footer: true
---
All add-ons are simple docker containers. You can use our [build scripts][builder] to automate the whole build process or you can build your own docker image and push it manually to a docker hub. Inside your add-on `config.json` you specify the Docker image that will be installed for your add-on:
There are two different ways of publishing add-ons. One is to publish pre-build containers to Docker Hub and the other option is to have users build the containers locally on their Hass.io instance.
**Pre-build containers**<br>
With pre-build containers, the developer is responsible for building the images for each architecture on their machine and push the results out to Docker Hub. This has a lot of advantages for the user. As a user it will only have to download the final container and be up and running once the download finishes. This makes the installation process fast and almost no chance of failure. This is the preferred method.
We have automated the process of building and publishing add-ons. See below for the instructions.
**Locally build containers**<br>
Starting Hass.io 0.26, it is possible to distribute add-ons that will be built on the users machine. The advantage is that as a developer it is easy to test an idea and see if people are interested in your add-ons. This method includes installing and potentially compiling code. This means that installing such an add-on is slow and adds more wear and tear to users SD card/hard drive than the above mentioned pre-build solution. It also has a higher chance of failure if one of the dependencies of the container has changed or is no longer available.
Use this option when you are playing with add-ons and seeing if someone is interested in your work. Once you're an established repository, please migrate to pushing builds to Docker Hub as it greatly improves the user experience. In the future we will mark locally built add-ons in the add-on store to warn users.
## {% linkable_title Build scripts to publish add-ons to Docker Hub %}
All add-ons are simple docker containers. Inside your add-on `config.json` you specify the Docker image that will be installed for your add-on:
```json
{
"image": "myhub/image-{arch}-addon-name"
…
"image": "myhub/image-{arch}-addon-name",
…
}
```
You can use `{arch}` inside the image name to support multiple architectures with 1 configuration file. It will be replaced with the architecture of the user when we load the image.
Development best practices is to merge your changes into a branch like `build`. After you push the add-on to [Docker Hub](https://hub.docker.com/), you can merge this branch to master.
Hass.io assumes that the `master` branch of your add-on repository matches the latest tag on Docker Hub. When you're building a new version, it's suggested that you use another branch, ie `build`. After you push the add-on to [Docker Hub](https://hub.docker.com/), you can merge this branch to master.
## {% linkable_title Custom Add-ons %}

2
source/hassio/debugging.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
---
The following debug tips and tricks are for people who are running the Hass.io image. If you use the generic Linux installer script, you should be able to access your host and logs as per your host.
The following debug tips and tricks are for people who are running the Hass.io image and are working on the base image. If you use the generic Linux installer script, you should be able to access your host and logs as per your host.
## {% linkable_title SSH access to the host %}