3.8 KiB
title
| title |
|---|
| Presenting your add-on |
If you decide to share your add-on to the public, paying attention to details is recommended. Of course, your add-on should have a proper name and description, but Hass.io also gives you some other tools to present your add-on even nicer.
Adding documentation
Good documentation helps the consumer of your add-on to understand its usage, explains configuration options, points users in the right direction in the case they have questions or issues, and contains the license under which the add-on was published.
This file containing the documentation is usually referred to as the "README", which is generally published as the README.md file.
Take a look at other projects for inspiration. For example, see the README.md of the Community Hass.io Add-ons: Homebridge add-on.
In future versions of Hass.io, the README.md file will be displayed in the Home Assistant frontend.
Add-on icon & logo
A picture is worth a thousand words. Therefore, your add-on can be improved by adding a proper image icon and logo. Those images are used when showing your add-on in the Home Assistant Hass.io panel and which will significantly improve the visual representation of your add-on.
Requirements for the logo of your add-on:
- The logo must be in the Portable Network Graphics format (
.png). - The filename must be
logo.png. - It is recommended to keep the logo size around 250x100px. You may choose to use a different size or aspect ratio as you seem fit for your add-on.
Requirements for the icon of your add-on:
- The icon must be in the Portable Network Graphics format (
.png). - The filename must be
icon.png. - The aspect ratio of the icon must be 1x1 (square).
- It is recommended to use an icon size of 128x128px.
Keeping a changelog
It is likely you are going to release newer versions of your add-on in the future. In case that happens, the users of your add-on would see an upgrade notice and probably want to know what changes were made in the latest version.
A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of your add-on and is generally published as the CHANGELOG.md file.
If you are in need of a guide on keeping a changelog, we would recommend checking the keep a changelog website. They have developed a standard that is used by many opensource projects around the world.
In future versions of Hass.io, the CHANGELOG.md file will be displayed in the Home Assistant frontend.
AppArmor
You can use own security profile for you Add-on with AppArmor. Default it is enabled and use the Docker default profile. Put apparmor.txt file into your Add-on folder and it will load this file as primary profile. Use the config options to set the name of that profile.
Ingress
Ingress allow to reach the Add-on web interface inside Home Assistant UI. User and Add-on developer need not care about the security or port forwarding. This feature would be loved by user and is not every time simple to implement for Add-on developer.
The Add-on need provide the webinterface on port 8099. This is configurable over the Add-on config, like a lot more. Make sure that the Add-on accept only connection from 172.30.32.2 on that port and he don't need provide any user login mechanics on this port. Now set ingress: true on Add-on configuration. You can read all details around path/port from your Add-on info API endpoint if you need this details to configure the web app.
If your web interface don't support relative path or you can't set a base url, you can use nginx filter to replace the URL with correct path.
Ingress API gateway support:
- HTTP/1.x
- Streaming content
- Websockets