mirror of
https://github.com/hassio-addons/addon-tasmoadmin.git
synced 2025-05-05 11:31:27 +00:00
✏️ Split add-on documentation
This commit is contained in:
Franck Nijhof
parent
c143560c4e
commit
8dea3c292b
3 changed files with 166 additions and 100 deletions
99
README.md
99
README.md
|
|
@ -37,101 +37,7 @@ Some of its features:
|
||||||
- Send out firmware updates over the air to one or more your devices at once
|
- Send out firmware updates over the air to one or more your devices at once
|
||||||
- Can automatically download the latest firmware for you
|
- Can automatically download the latest firmware for you
|
||||||
|
|
||||||
## Installation
|
[:books: Read the full add-on documentation][docs]
|
||||||
|
|
||||||
The installation of this add-on is pretty straightforward and not different in
|
|
||||||
comparison to installing any other Home Assistant add-on.
|
|
||||||
|
|
||||||
1. Search for the "TasmoAdmin" add-on in the Supervisor add-on store.
|
|
||||||
1. Install the "TasmoAdmin" add-on.
|
|
||||||
1. Start the "TasmoAdmin" add-on.
|
|
||||||
1. Check the logs of the “TasmoAdmin” add-on to see if everything went well.
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
**Note**: _Remember to restart the add-on when the configuration is changed._
|
|
||||||
|
|
||||||
Example add-on configuration:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
log_level: info
|
|
||||||
ssl: false
|
|
||||||
certfile: fullchain.pem
|
|
||||||
keyfile: privkey.pem
|
|
||||||
ipv6: true
|
|
||||||
```
|
|
||||||
|
|
||||||
**Note**: _This is just an example, don't copy and past it! Create your own!_
|
|
||||||
|
|
||||||
### Option: `log_level`
|
|
||||||
|
|
||||||
The `log_level` option controls the level of log output by the addon and can
|
|
||||||
be changed to be more or less verbose, which might be useful when you are
|
|
||||||
dealing with an unknown issue. Possible values are:
|
|
||||||
|
|
||||||
- `trace`: Show every detail, like all called internal functions.
|
|
||||||
- `debug`: Shows detailed debug information.
|
|
||||||
- `info`: Normal (usually) interesting events.
|
|
||||||
- `warning`: Exceptional occurrences that are not errors.
|
|
||||||
- `error`: Runtime errors that do not require immediate action.
|
|
||||||
- `fatal`: Something went terribly wrong. Add-on becomes unusable.
|
|
||||||
|
|
||||||
Please note that each level automatically includes log messages from a
|
|
||||||
more severe level, e.g., `debug` also shows `info` messages. By default,
|
|
||||||
the `log_level` is set to `info`, which is the recommended setting unless
|
|
||||||
you are troubleshooting.
|
|
||||||
|
|
||||||
### Option: `ssl`
|
|
||||||
|
|
||||||
Enables/Disables SSL (HTTPS) on the web interface of TasmoAdmin
|
|
||||||
Panel. Set it `true` to enable it, `false` otherwise.
|
|
||||||
|
|
||||||
### Option: `certfile`
|
|
||||||
|
|
||||||
The certificate file to use for SSL.
|
|
||||||
|
|
||||||
**Note**: _The file MUST be stored in `/ssl/`, which is the default_
|
|
||||||
|
|
||||||
### Option: `keyfile`
|
|
||||||
|
|
||||||
The private key file to use for SSL.
|
|
||||||
|
|
||||||
**Note**: _The file MUST be stored in `/ssl/`, which is the default_
|
|
||||||
|
|
||||||
### Option: `ipv6`
|
|
||||||
|
|
||||||
Set this option too `false` to disable IPv6 support.
|
|
||||||
|
|
||||||
## Embedding into Home Assistant
|
|
||||||
|
|
||||||
It is possible to embed the TasmoAdmin interface directly into Home Assistant,
|
|
||||||
allowing you to access it through the Home Assistant frontend.
|
|
||||||
|
|
||||||
Home Assistant provides the `panel_iframe` integration, for these purposes.
|
|
||||||
|
|
||||||
Example configuration:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
panel_iframe:
|
|
||||||
tasmoadmin:
|
|
||||||
title: TasmoAdmin
|
|
||||||
icon: mdi:lightbulb-on
|
|
||||||
url: http://addres.to.your.hass.io:9541
|
|
||||||
```
|
|
||||||
|
|
||||||
## Changelog & Releases
|
|
||||||
|
|
||||||
This repository keeps a change log using [GitHub's releases][releases]
|
|
||||||
functionality. The format of the log is based on
|
|
||||||
[Keep a Changelog][keepchangelog].
|
|
||||||
|
|
||||||
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
|
## Support
|
||||||
|
|
||||||
|
|
@ -206,6 +112,7 @@ SOFTWARE.
|
||||||
[discord-ha]: https://discord.gg/c5DvZ4e
|
[discord-ha]: https://discord.gg/c5DvZ4e
|
||||||
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||||
[discord]: https://discord.me/hassioaddons
|
[discord]: https://discord.me/hassioaddons
|
||||||
|
[docs]: https://github.com/hassio-addons/addon-tasmoadmin/blob/master/tasmoadmin/DOCS.md
|
||||||
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
||||||
[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-tasmoadmin/54155?u=frenck
|
[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-tasmoadmin/54155?u=frenck
|
||||||
[frenck]: https://github.com/frenck
|
[frenck]: https://github.com/frenck
|
||||||
|
|
@ -215,7 +122,6 @@ SOFTWARE.
|
||||||
[gitlabci]: https://gitlab.com/hassio-addons/addon-tasmoadmin/pipelines
|
[gitlabci]: https://gitlab.com/hassio-addons/addon-tasmoadmin/pipelines
|
||||||
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
|
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
|
||||||
[issue]: https://github.com/hassio-addons/addon-tasmoadmin/issues
|
[issue]: https://github.com/hassio-addons/addon-tasmoadmin/issues
|
||||||
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
|
|
||||||
[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-tasmoadmin.svg
|
[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-tasmoadmin.svg
|
||||||
[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg
|
||||||
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
|
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
|
||||||
|
|
@ -225,4 +131,3 @@ SOFTWARE.
|
||||||
[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-tasmoadmin.svg
|
[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-tasmoadmin.svg
|
||||||
[releases]: https://github.com/hassio-addons/addon-tasmoadmin/releases
|
[releases]: https://github.com/hassio-addons/addon-tasmoadmin/releases
|
||||||
[repository]: https://github.com/hassio-addons/repository
|
[repository]: https://github.com/hassio-addons/repository
|
||||||
[semver]: http://semver.org/spec/v2.0.0.html
|
|
||||||
|
|
|
||||||
|
|
@ -22,8 +22,6 @@ Some of its features:
|
||||||
- Send out firmware updates over the air to one or more your devices at once
|
- Send out firmware updates over the air to one or more your devices at once
|
||||||
- Can automatically download the latest firmware for you
|
- Can automatically download the latest firmware for you
|
||||||
|
|
||||||
[Click here for the full documentation][docs]
|
|
||||||
|
|
||||||
![TasmoAdmin screenshot][screenshot]
|
![TasmoAdmin screenshot][screenshot]
|
||||||
|
|
||||||
{% if channel == "edge" %}
|
{% if channel == "edge" %}
|
||||||
|
|
@ -67,7 +65,6 @@ If you are more interested in stable releases of our add-ons:
|
||||||
{% endif %}
|
{% endif %}
|
||||||
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||||
[discord]: https://discord.me/hassioaddons
|
[discord]: https://discord.me/hassioaddons
|
||||||
[docs]: {{ repo }}/blob/{{ version }}/README.md
|
|
||||||
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
||||||
[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-tasmoadmin/54155?u=frenck
|
[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-tasmoadmin/54155?u=frenck
|
||||||
[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
|
[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
|
||||||
|
|
|
||||||
164
tasmoadmin/DOCS.md
Normal file
164
tasmoadmin/DOCS.md
Normal file
|
|
@ -0,0 +1,164 @@
|
||||||
|
# Home Assistant Community Add-on: TasmoAdmin
|
||||||
|
|
||||||
|
TasmoAdmin (formerly known as SonWEB) is an administrative web interface to
|
||||||
|
manage all your Sonoff-Tasmota flashed devices centrally.
|
||||||
|
Some of its features:
|
||||||
|
|
||||||
|
- Scans your networks and adds your devices automatically
|
||||||
|
- See the status of all your devices quick and easy
|
||||||
|
- Configure all your devices from a single place
|
||||||
|
- Send out firmware updates over the air to one or more your devices at once
|
||||||
|
- Can automatically download the latest firmware for you
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
The installation of this add-on is pretty straightforward and not different in
|
||||||
|
comparison to installing any other Home Assistant add-on.
|
||||||
|
|
||||||
|
1. Search for the "TasmoAdmin" add-on in the Supervisor add-on store.
|
||||||
|
1. Install the "TasmoAdmin" add-on.
|
||||||
|
1. Start the "TasmoAdmin" add-on.
|
||||||
|
1. Check the logs of the “TasmoAdmin” add-on to see if everything went well.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
**Note**: _Remember to restart the add-on when the configuration is changed._
|
||||||
|
|
||||||
|
Example add-on configuration:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
log_level: info
|
||||||
|
ssl: false
|
||||||
|
certfile: fullchain.pem
|
||||||
|
keyfile: privkey.pem
|
||||||
|
ipv6: true
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note**: _This is just an example, don't copy and past it! Create your own!_
|
||||||
|
|
||||||
|
### Option: `log_level`
|
||||||
|
|
||||||
|
The `log_level` option controls the level of log output by the addon and can
|
||||||
|
be changed to be more or less verbose, which might be useful when you are
|
||||||
|
dealing with an unknown issue. Possible values are:
|
||||||
|
|
||||||
|
- `trace`: Show every detail, like all called internal functions.
|
||||||
|
- `debug`: Shows detailed debug information.
|
||||||
|
- `info`: Normal (usually) interesting events.
|
||||||
|
- `warning`: Exceptional occurrences that are not errors.
|
||||||
|
- `error`: Runtime errors that do not require immediate action.
|
||||||
|
- `fatal`: Something went terribly wrong. Add-on becomes unusable.
|
||||||
|
|
||||||
|
Please note that each level automatically includes log messages from a
|
||||||
|
more severe level, e.g., `debug` also shows `info` messages. By default,
|
||||||
|
the `log_level` is set to `info`, which is the recommended setting unless
|
||||||
|
you are troubleshooting.
|
||||||
|
|
||||||
|
### Option: `ssl`
|
||||||
|
|
||||||
|
Enables/Disables SSL (HTTPS) on the web interface of TasmoAdmin
|
||||||
|
Panel. Set it `true` to enable it, `false` otherwise.
|
||||||
|
|
||||||
|
### Option: `certfile`
|
||||||
|
|
||||||
|
The certificate file to use for SSL.
|
||||||
|
|
||||||
|
**Note**: _The file MUST be stored in `/ssl/`, which is the default_
|
||||||
|
|
||||||
|
### Option: `keyfile`
|
||||||
|
|
||||||
|
The private key file to use for SSL.
|
||||||
|
|
||||||
|
**Note**: _The file MUST be stored in `/ssl/`, which is the default_
|
||||||
|
|
||||||
|
### Option: `ipv6`
|
||||||
|
|
||||||
|
Set this option too `false` to disable IPv6 support.
|
||||||
|
|
||||||
|
## Embedding into Home Assistant
|
||||||
|
|
||||||
|
It is possible to embed the TasmoAdmin interface directly into Home Assistant,
|
||||||
|
allowing you to access it through the Home Assistant frontend.
|
||||||
|
|
||||||
|
Home Assistant provides the `panel_iframe` integration, for these purposes.
|
||||||
|
|
||||||
|
Example configuration:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
panel_iframe:
|
||||||
|
tasmoadmin:
|
||||||
|
title: TasmoAdmin
|
||||||
|
icon: mdi:lightbulb-on
|
||||||
|
url: http://addres.to.your.hass.io:9541
|
||||||
|
```
|
||||||
|
|
||||||
|
## Changelog & Releases
|
||||||
|
|
||||||
|
This repository keeps a change log using [GitHub's releases][releases]
|
||||||
|
functionality. The format of the log is based on
|
||||||
|
[Keep a Changelog][keepchangelog].
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## 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].
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2018-2020 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.
|
||||||
|
|
||||||
|
[contributors]: https://github.com/hassio-addons/addon-tasmoadmin/graphs/contributors
|
||||||
|
[discord-ha]: https://discord.gg/c5DvZ4e
|
||||||
|
[discord]: https://discord.me/hassioaddons
|
||||||
|
[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-tasmoadmin/54155?u=frenck
|
||||||
|
[frenck]: https://github.com/frenck
|
||||||
|
[issue]: https://github.com/hassio-addons/addon-tasmoadmin/issues
|
||||||
|
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
|
||||||
|
[reddit]: https://reddit.com/r/homeassistant
|
||||||
|
[releases]: https://github.com/hassio-addons/addon-tasmoadmin/releases
|
||||||
|
[semver]: http://semver.org/spec/v2.0.0.html
|
||||||
Loading…
Add table
Add a link
Reference in a new issue