jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2017-05-14 22:58:49 UTC

Browse source
This commit is contained in:
Travis CI 2017-05-14 22:58:49 +00:00
parent 9912eb49b7
commit 8fbd710b09
42 changed files with 73 additions and 61 deletions
Download patch file Download diff file Expand all files Collapse all files

2
hassio/addon_config/index.html
View file

@ -243,7 +243,6 @@ CMD [ "/run.sh" ]
<a href='/hassio/'>Hass.io </a>
<ul>
<li><a href='/hassio/installation/'>Installation </a></li>
<li><a href='/hassio/debugging/'>Debugging </a></li>
<li><a href='/addons/'>Available add-ons </a></li>
<li><a href='/hassio/installing_third_party_addons/'>Installing third-party add-ons </a></li>
<li><a href='/hassio/architecture/'>Architecture </a></li>
@ -261,6 +260,7 @@ CMD [ "/run.sh" ]
<li><a href='/hassio/addon_repository/'>Repositories </a></li>
</ul>
</li>
<li><a href='/hassio/debugging/'>Debugging Hass.io </a></li>
</ul>
</div>
</section>

2
hassio/addon_development/index.html
View file

@ -81,7 +81,6 @@
<a href='/hassio/'>Hass.io </a>
<ul>
<li><a href='/hassio/installation/'>Installation </a></li>
<li><a href='/hassio/debugging/'>Debugging </a></li>
<li><a href='/addons/'>Available add-ons </a></li>
<li><a href='/hassio/installing_third_party_addons/'>Installing third-party add-ons </a></li>
<li><a href='/hassio/architecture/'>Architecture </a></li>
@ -99,6 +98,7 @@
<li><a href='/hassio/addon_repository/'>Repositories </a></li>
</ul>
</li>
<li><a href='/hassio/debugging/'>Debugging Hass.io </a></li>
</ul>
</div>
</section>

22
hassio/addon_publishing/index.html
View file

@ -67,14 +67,26 @@
</h1>
</header>
<hr class="divider">
<p>All add-ons are simple docker containers. You can use our <a href="https://github.com/home-assistant/hassio-build/tree/master/build-scripts/addons">build scripts</a> 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 <code class="highlighter-rouge">config.json</code> you specify the Docker image that will be installed for your add-on:</p>
<p>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.</p>
<p><strong>Pre-build containers</strong><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.</p>
<p>We have automated the process of building and publishing add-ons. See below for the instructions.</p>
<p><strong>Locally build containers</strong><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.</p>
<p>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.</p>
<h2><a class="title-link" name="build-scripts-to-publish-add-ons-to-docker-hub" href="#build-scripts-to-publish-add-ons-to-docker-hub"></a> Build scripts to publish add-ons to Docker Hub</h2>
<p>All add-ons are simple docker containers. Inside your add-on <code class="highlighter-rouge">config.json</code> you specify the Docker image that will be installed for your add-on:</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"image"</span><span class="p">:</span><span class="w"> </span><span class="s2">"myhub/image-{arch}-addon-name"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="err">…</span><span class="w">
</span><span class="nt">"image"</span><span class="p">:</span><span class="w"> </span><span class="s2">"myhub/image-{arch}-addon-name"</span><span class="p">,</span><span class="w">
</span><span class="err">…</span><span class="w">
</span><span class="err">}</span><span class="w">
</span></code></pre>
</div>
<p>You can use <code class="highlighter-rouge"><span class="p">{</span><span class="err">arch</span><span class="p">}</span></code> 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.</p>
<p>Development best practices is to merge your changes into a branch like <code class="highlighter-rouge">build</code>. After you push the add-on to <a href="https://hub.docker.com/">Docker Hub</a>, you can merge this branch to master.</p>
<p>Hass.io assumes that the <code class="highlighter-rouge">master</code> 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 <code class="highlighter-rouge">build</code>. After you push the add-on to <a href="https://hub.docker.com/">Docker Hub</a>, you can merge this branch to master.</p>
<h2><a class="title-link" name="custom-add-ons" href="#custom-add-ons"></a> Custom Add-ons</h2>
<p>You need a Docker Hub account to make your own add-ons. Download our <a href="https://github.com/home-assistant/hassio-build/tree/master/build-scripts/addons">build script</a> and run one of the following commands.</p>
<p>For a git repository:</p>
@ -108,7 +120,6 @@
<a href='/hassio/'>Hass.io </a>
<ul>
<li><a href='/hassio/installation/'>Installation </a></li>
<li><a href='/hassio/debugging/'>Debugging </a></li>
<li><a href='/addons/'>Available add-ons </a></li>
<li><a href='/hassio/installing_third_party_addons/'>Installing third-party add-ons </a></li>
<li><a href='/hassio/architecture/'>Architecture </a></li>
@ -126,6 +137,7 @@
<li><a href='/hassio/addon_repository/'>Repositories </a></li>
</ul>
</li>
<li><a href='/hassio/debugging/'>Debugging Hass.io </a></li>
</ul>
</div>
</section>

2
hassio/addon_repository/index.html
View file

@ -118,7 +118,6 @@
<a href='/hassio/'>Hass.io </a>
<ul>
<li><a href='/hassio/installation/'>Installation </a></li>
<li><a href='/hassio/debugging/'>Debugging </a></li>
<li><a href='/addons/'>Available add-ons </a></li>
<li><a href='/hassio/installing_third_party_addons/'>Installing third-party add-ons </a></li>
<li><a href='/hassio/architecture/'>Architecture </a></li>
@ -136,6 +135,7 @@
<li><a class='active' href='/hassio/addon_repository/'>Repositories </a></li>
</ul>
</li>
<li><a href='/hassio/debugging/'>Debugging Hass.io </a></li>
</ul>
</div>
</section>

2
hassio/addon_testing/index.html
View file

@ -93,7 +93,6 @@
<a href='/hassio/'>Hass.io </a>
<ul>
<li><a href='/hassio/installation/'>Installation </a></li>
<li><a href='/hassio/debugging/'>Debugging </a></li>
<li><a href='/addons/'>Available add-ons </a></li>
<li><a href='/hassio/installing_third_party_addons/'>Installing third-party add-ons </a></li>
<li><a href='/hassio/architecture/'>Architecture </a></li>
@ -111,6 +110,7 @@
<li><a href='/hassio/addon_repository/'>Repositories </a></li>
</ul>
</li>
<li><a href='/hassio/debugging/'>Debugging Hass.io </a></li>
</ul>
</div>
</section>

2
hassio/addon_tutorial/index.html
View file

@ -237,7 +237,6 @@ The Python 3 server will allow you to browse the /data folder.
<a href='/hassio/'>Hass.io </a>
<ul>
<li><a href='/hassio/installation/'>Installation </a></li>
<li><a href='/hassio/debugging/'>Debugging </a></li>
<li><a href='/addons/'>Available add-ons </a></li>
<li><a href='/hassio/installing_third_party_addons/'>Installing third-party add-ons </a></li>
<li><a href='/hassio/architecture/'>Architecture </a></li>
@ -255,6 +254,7 @@ The Python 3 server will allow you to browse the /data folder.
<li><a href='/hassio/addon_repository/'>Repositories </a></li>
</ul>
</li>
<li><a href='/hassio/debugging/'>Debugging Hass.io </a></li>
</ul>
</div>
</section>

2
hassio/architecture/index.html
View file

@ -96,7 +96,6 @@
<a href='/hassio/'>Hass.io </a>
<ul>
<li><a href='/hassio/installation/'>Installation </a></li>
<li><a href='/hassio/debugging/'>Debugging </a></li>
<li><a href='/addons/'>Available add-ons </a></li>
<li><a href='/hassio/installing_third_party_addons/'>Installing third-party add-ons </a></li>
<li><a class='active' href='/hassio/architecture/'>Architecture </a></li>
@ -114,6 +113,7 @@
<li><a href='/hassio/addon_repository/'>Repositories </a></li>
</ul>
</li>
<li><a href='/hassio/debugging/'>Debugging Hass.io </a></li>
</ul>
</div>
</section>

4
hassio/debugging/index.html
View file

@ -67,7 +67,7 @@
</h1>
</header>
<hr class="divider">
<p>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.</p>
<p>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.</p>
<h2><a class="title-link" name="ssh-access-to-the-host" href="#ssh-access-to-the-host"></a> SSH access to the host</h2>
<p>Create an <code class="highlighter-rouge">authorized_keys</code> file in the root of your SD card with your public key. Once the device is booted, you can access your device as root over SSH on port 22222.</p>
<p>Windows instructions how to generate and use private/public keys with Putty are <a href="https://www.digitalocean.com/community/tutorials/how-to-use-ssh-keys-with-putty-on-digitalocean-droplets-windows-users">here</a>. Instead of the droplet instructions, add the public key as per above instructions.</p>
@ -94,7 +94,6 @@ docker logs homeassistant
<a href='/hassio/'>Hass.io </a>
<ul>
<li><a href='/hassio/installation/'>Installation </a></li>
<li><a class='active' href='/hassio/debugging/'>Debugging </a></li>
<li><a href='/addons/'>Available add-ons </a></li>
<li><a href='/hassio/installing_third_party_addons/'>Installing third-party add-ons </a></li>
<li><a href='/hassio/architecture/'>Architecture </a></li>
@ -112,6 +111,7 @@ docker logs homeassistant
<li><a href='/hassio/addon_repository/'>Repositories </a></li>
</ul>
</li>
<li><a class='active' href='/hassio/debugging/'>Debugging Hass.io </a></li>
</ul>
</div>
</section>

2
hassio/index.html
View file

@ -80,7 +80,6 @@
<a class='active' href='/hassio/'>Hass.io </a>
<ul>
<li><a href='/hassio/installation/'>Installation </a></li>
<li><a href='/hassio/debugging/'>Debugging </a></li>
<li><a href='/addons/'>Available add-ons </a></li>
<li><a href='/hassio/installing_third_party_addons/'>Installing third-party add-ons </a></li>
<li><a href='/hassio/architecture/'>Architecture </a></li>
@ -98,6 +97,7 @@
<li><a href='/hassio/addon_repository/'>Repositories </a></li>
</ul>
</li>
<li><a href='/hassio/debugging/'>Debugging Hass.io </a></li>
</ul>
</div>
</section>

2
hassio/installation/index.html
View file

@ -99,7 +99,6 @@ If you copy over your existing Home Assistant configuration, make sure to enable
<a href='/hassio/'>Hass.io </a>
<ul>
<li><a class='active' href='/hassio/installation/'>Installation </a></li>
<li><a href='/hassio/debugging/'>Debugging </a></li>
<li><a href='/addons/'>Available add-ons </a></li>
<li><a href='/hassio/installing_third_party_addons/'>Installing third-party add-ons </a></li>
<li><a href='/hassio/architecture/'>Architecture </a></li>
@ -117,6 +116,7 @@ If you copy over your existing Home Assistant configuration, make sure to enable
<li><a href='/hassio/addon_repository/'>Repositories </a></li>
</ul>
</li>
<li><a href='/hassio/debugging/'>Debugging Hass.io </a></li>
</ul>
</div>
</section>

2
hassio/installing_third_party_addons/index.html
View file

@ -93,7 +93,6 @@ Add the urls of repositories (one per line) and then press “Save”. A new car
<a href='/hassio/'>Hass.io </a>
<ul>
<li><a href='/hassio/installation/'>Installation </a></li>
<li><a href='/hassio/debugging/'>Debugging </a></li>
<li><a href='/addons/'>Available add-ons </a></li>
<li><a class='active' href='/hassio/installing_third_party_addons/'>Installing third-party add-ons </a></li>
<li><a href='/hassio/architecture/'>Architecture </a></li>
@ -111,6 +110,7 @@ Add the urls of repositories (one per line) and then press “Save”. A new car
<li><a href='/hassio/addon_repository/'>Repositories </a></li>
</ul>
</li>
<li><a href='/hassio/debugging/'>Debugging Hass.io </a></li>
</ul>
</div>
</section>