diff --git a/README.md b/README.md index c57777a2d..200e35ea9 100644 --- a/README.md +++ b/README.md @@ -1016,10 +1016,10 @@ SOFTWARE. [jupyterlablite-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg [jupyterlablite-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [jupyterlablite-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-log-viewer]: https://github.com/hassio-addons/addon-log-viewer/tree/fc17cd1 -[addon-doc-log-viewer]: https://github.com/hassio-addons/addon-log-viewer/blob/fc17cd1/README.md +[addon-log-viewer]: https://github.com/hassio-addons/addon-log-viewer/tree/65593d3 +[addon-doc-log-viewer]: https://github.com/hassio-addons/addon-log-viewer/blob/65593d3/README.md [log-viewer-issue]: https://github.com/hassio-addons/addon-log-viewer/issues -[log-viewer-version-shield]: https://img.shields.io/badge/version-fc17cd1-blue.svg +[log-viewer-version-shield]: https://img.shields.io/badge/version-65593d3-blue.svg [log-viewer-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/log-viewer-armhf.svg [log-viewer-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [log-viewer-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/log-viewer/CHANGELOG.md b/log-viewer/CHANGELOG.md index f0cbde9c2..c73b6452f 100644 --- a/log-viewer/CHANGELOG.md +++ b/log-viewer/CHANGELOG.md @@ -1,4 +1,5 @@ # Changelog since v0.8.1 +- ✏ Split add-on documentation - ⬆ Upgrades git to 2.24.3-r0 - 🔨 Implement OCI image specification on labels - ⬆ Upgrades add-on base image to v7.2.0 diff --git a/log-viewer/DOCS.md b/log-viewer/DOCS.md new file mode 100644 index 000000000..6c4c5e2d7 --- /dev/null +++ b/log-viewer/DOCS.md @@ -0,0 +1,157 @@ +# Home Assistant Community Add-on: Log Viewer + +Easily monitor your Home Assistant logs in your web browser. Custom filtering +is available to make it simple to differentiate different types of logs. + +## 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 "Log Viewer" add-on in the Supervisor add-on store and + install it. +1. Start the "Log Viewer" add-on +1. Check the logs of the "Log Viewer" add-on to see if everything went well. +1. Open the web UI for the "Log Viewer" add-on to start watching logs. + +**Tip:** To see more logs, be sure to enable the [`logger`][logger] integration + in your Home Assistant `configuration.yaml`: + +```yaml +logger: + default: info +``` + +## 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 +``` + +**Note**: _This is just an example, don't copy and paste 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 on the Log Viewer. Set it `true` to enable it, +`false` otherwise. + +**Note**: _The SSL settings only apply to direct access and has no effect +on the Ingress service._ + +### 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: `leave_front_door_open` + +Adding this option to the add-on configuration allows you to disable +authentication on the add-on by setting it to `true` and leaving the +username and password empty. + +**Note**: _We STRONGLY suggest, not to use this, even if this add-on is +only exposed to your internal network. USE AT YOUR OWN RISK!_ + +## 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 [Dale Higgs][dale3h]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2018-2020 Dale Higgs <@dale3h> + +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-log-viewer/graphs/contributors +[dale3h]: https://github.com/dale3h +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-log-viewer/64377?u=dale3h +[issue]: https://github.com/hassio-addons/addon-log-viewer/issues +[keepchangelog]: https://keepachangelog.com/en/1.0.0/ +[logger]: https://www.home-assistant.io/integrations/logger/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-log-viewer/releases +[semver]: https://semver.org/spec/v2.0.0 diff --git a/log-viewer/README.md b/log-viewer/README.md index 862a92c34..2ef2fa9d4 100644 --- a/log-viewer/README.md +++ b/log-viewer/README.md @@ -13,8 +13,6 @@ Browser-based log utility for Home Assistant. Easily monitor your Home Assistant logs in your web browser. Custom filtering is available to make it simple to differentiate different types of logs. -[Click here for the full documentation][docs] - ## WARNING! THIS IS AN EDGE VERSION! This Home Assistant Add-ons repository contains edge builds of add-ons. @@ -38,10 +36,9 @@ If you are more interested in stable releases of our add-ons: [buymeacoffee]: https://www.buymeacoffee.com/dale3h [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[docs]: https://github.com/hassio-addons/addon-log-viewer/blob/fc17cd1/README.md [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-log-viewer/64377?u=dale3h [maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg -[release-shield]: https://img.shields.io/badge/version-fc17cd1-blue.svg -[release]: https://github.com/hassio-addons/addon-log-viewer/tree/fc17cd1 \ No newline at end of file +[release-shield]: https://img.shields.io/badge/version-65593d3-blue.svg +[release]: https://github.com/hassio-addons/addon-log-viewer/tree/65593d3 \ No newline at end of file diff --git a/log-viewer/config.json b/log-viewer/config.json index 00a1d08c2..5db750741 100644 --- a/log-viewer/config.json +++ b/log-viewer/config.json @@ -1,6 +1,6 @@ { "name": "Log Viewer", - "version": "fc17cd1", + "version": "65593d3", "slug": "logviewer", "description": "Browser-based log utility for Home Assistant", "url": "https://github.com/hassio-addons/addon-log-viewer",