mirror of
https://github.com/hassio-addons/addon-base.git
synced 2025-05-03 18:31:26 +00:00
150 lines
6.1 KiB
Markdown
150 lines
6.1 KiB
Markdown
# Home Assistant Community Add-on: Base Images
|
|
|
|
[![GitHub Release][releases-shield]][releases]
|
|
![Project Stage][project-stage-shield]
|
|
[![License][license-shield]](LICENSE.md)
|
|
|
|
![Supports aarch64 Architecture][aarch64-shield]
|
|
![Supports amd64 Architecture][amd64-shield]
|
|
![Supports armhf Architecture][armhf-shield]
|
|
![Supports armv7 Architecture][armv7-shield]
|
|
![Supports i386 Architecture][i386-shield]
|
|
|
|
[![GitHub Actions][github-actions-shield]][github-actions]
|
|
![Project Maintenance][maintenance-shield]
|
|
[![GitHub Activity][commits-shield]][commits]
|
|
|
|
[![Discord][discord-shield]][discord]
|
|
[![Community Forum][forum-shield]][forum]
|
|
|
|
[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]
|
|
|
|
[![Support Frenck on Patreon][patreon-shield]][patreon]
|
|
|
|
Docker base images used by Home Assistant Community Add-ons.
|
|
|
|
## About
|
|
|
|
These are the base images used by add-ons created by the
|
|
Home Assistant Community Add-ons.
|
|
|
|
While Home Assistant provides base images, the images provided by this
|
|
repository contain some extras:
|
|
|
|
- Adds [s6] as a process supervisor.
|
|
- Adds `jq` & `curl`, since every add-on uses them.
|
|
- Adds Docker [Label Schema][label-schema] support.
|
|
- Includes a helper library: [Bashio][bashio]
|
|
- Includes template helper: [tempio][tempio]
|
|
- Handles logs, add-on startup banners and update notifications.
|
|
- Several small adjustments and improvements.
|
|
|
|
## Changelog & Releases
|
|
|
|
This repository keeps a change log using [GitHub's releases][releases]
|
|
functionality.
|
|
|
|
Releases are based on [Semantic Versioning][semver], and use the format
|
|
of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented
|
|
based on the following:
|
|
|
|
- `MAJOR`: Incompatible or major changes.
|
|
- `MINOR`: Backwards-compatible new features and enhancements.
|
|
- `PATCH`: Backwards-compatible bugfixes and package updates.
|
|
|
|
## Support
|
|
|
|
Got questions?
|
|
|
|
You have several options to get them answered:
|
|
|
|
- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on
|
|
support and feature requests.
|
|
- The [Home Assistant Discord Chat Server][discord-ha] for general Home
|
|
Assistant discussions and questions.
|
|
- The Home Assistant [Community Forum][forum].
|
|
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
|
|
|
|
You could also [open an issue here][issue] GitHub.
|
|
|
|
## Contributing
|
|
|
|
This is an active open-source project. We are always open to people who want to
|
|
use the code or contribute to it.
|
|
|
|
We've set up a separate document for our
|
|
[contribution guidelines](CONTRIBUTING.md).
|
|
|
|
Thank you for being involved! :heart_eyes:
|
|
|
|
## Authors & contributors
|
|
|
|
The original setup of this repository is by [Franck Nijhof][frenck].
|
|
|
|
For a full list of all authors and contributors,
|
|
check [the contributor's page][contributors].
|
|
|
|
## We have got some Home Assistant add-ons for you
|
|
|
|
Want some more functionality to your Home Assistant instance?
|
|
|
|
We have created multiple add-ons for Home Assistant. For a full list, check out
|
|
our [GitHub Repository][repository].
|
|
|
|
## License
|
|
|
|
MIT License
|
|
|
|
Copyright (c) 2017-2025 Franck Nijhof
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
SOFTWARE.
|
|
|
|
[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
|
|
[bashio]: https://github.com/hassio-addons/bashio
|
|
[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-base.svg
|
|
[commits]: https://github.com/hassio-addons/addon-base/commits/main
|
|
[contributors]: https://github.com/hassio-addons/addon-base/graphs/contributors
|
|
[discord-ha]: https://discord.gg/c5DvZ4e
|
|
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
|
[discord]: https://discord.me/hassioaddons
|
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
|
[forum]: https://community.home-assistant.io/?u=frenck
|
|
[frenck]: https://github.com/frenck
|
|
[github-actions-shield]: https://github.com/hassio-addons/addon-base/workflows/CI/badge.svg
|
|
[github-actions]: https://github.com/hassio-addons/addon-base/actions
|
|
[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
|
|
[github-sponsors]: https://github.com/sponsors/frenck
|
|
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
|
|
[issue]: https://github.com/hassio-addons/addon-base/issues
|
|
[label-schema]: http://label-schema.org/
|
|
[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-base.svg
|
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg
|
|
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
|
|
[patreon]: https://www.patreon.com/frenck
|
|
[project-stage-shield]: https://img.shields.io/badge/Project%20Stage-Production%20Ready-brightgreen.svg
|
|
[reddit]: https://reddit.com/r/homeassistant
|
|
[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-base.svg
|
|
[releases]: https://github.com/hassio-addons/addon-base/releases
|
|
[repository]: https://github.com/hassio-addons/repository
|
|
[s6]: http://skarnet.org/software/s6/overview.html
|
|
[semver]: http://semver.org/spec/v2.0.0.html
|
|
[tempio]: https://github.com/home-assistant/tempio
|