init
This commit is contained in:
24
log-viewer/CHANGELOG.md
Normal file
24
log-viewer/CHANGELOG.md
Normal file
@@ -0,0 +1,24 @@
|
||||
## What’s changed
|
||||
|
||||
## ✨ New features
|
||||
|
||||
- Add translation support @frenck (#86)
|
||||
|
||||
## 🚀 Enhancements
|
||||
|
||||
- Remove NGINX access log from Supervisor log output @frenck (#85)
|
||||
|
||||
## 🧰 Maintenance
|
||||
|
||||
- Apply updated repository structure & CI workflow @frenck (#84)
|
||||
|
||||
## ⬆️ Dependency updates
|
||||
|
||||
- ⬆️ Bump actions/cache from v2.1.4 to v2.1.5 @dependabot (#75)
|
||||
- ⬆️ Upgrades nodejs to 14.16.1-r1 @frenck (#76)
|
||||
- ⬆️ Bump brpaz/hadolint-action from v1.3.1 to v1.4.0 @dependabot (#77)
|
||||
- ⬆️ Bump docker/setup-buildx-action from v1.1.2 to v1.2.0 @dependabot (#78)
|
||||
- ⬆️ Bump docker/setup-qemu-action from v1.0.2 to v1.1.0 @dependabot (#79)
|
||||
- ⬆️ Bump docker/login-action from v1.8.0 to v1.9.0 @dependabot (#80)
|
||||
- ⬆️ Bump docker/setup-buildx-action from v1.2.0 to v1.3.0 @dependabot (#81)
|
||||
- ⬆️ Upgrades add-on base image to v9.2.0 @frenck (#83)
|
||||
155
log-viewer/DOCS.md
Normal file
155
log-viewer/DOCS.md
Normal file
@@ -0,0 +1,155 @@
|
||||
# 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.
|
||||
|
||||
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-2021 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
|
||||
[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
|
||||
25
log-viewer/README.md
Normal file
25
log-viewer/README.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Home Assistant Community Add-on: Log Viewer
|
||||
|
||||
[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
|
||||
|
||||
[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
|
||||
|
||||
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
|
||||
|
||||
Browser-based log utility for Home Assistant.
|
||||
|
||||
## About
|
||||
|
||||
Easily monitor your Home Assistant logs in your web browser. Custom filtering
|
||||
is available to make it simple to differentiate different types of logs.
|
||||
|
||||
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
|
||||
[buymeacoffee]: https://www.buymeacoffee.com/dale3h
|
||||
[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/t/home-assistant-community-add-on-log-viewer/64377?u=dale3h
|
||||
[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
|
||||
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
|
||||
[release-shield]: https://img.shields.io/badge/version-v0.11.0-blue.svg
|
||||
[release]: https://github.com/hassio-addons/addon-log-viewer/tree/v0.11.0
|
||||
44
log-viewer/config.json
Normal file
44
log-viewer/config.json
Normal file
@@ -0,0 +1,44 @@
|
||||
{
|
||||
"name": "Log Viewer",
|
||||
"version": "0.11.0",
|
||||
"slug": "logviewer",
|
||||
"description": "Browser-based log utility for Home Assistant",
|
||||
"url": "https://github.com/hassio-addons/addon-log-viewer",
|
||||
"init": false,
|
||||
"ingress": true,
|
||||
"panel_icon": "mdi:text-box-outline",
|
||||
"homeassistant": "0.92.0b2",
|
||||
"arch": [
|
||||
"aarch64",
|
||||
"amd64",
|
||||
"armhf",
|
||||
"armv7",
|
||||
"i386"
|
||||
],
|
||||
"homeassistant_api": true,
|
||||
"auth_api": true,
|
||||
"ports": {
|
||||
"80/tcp": null
|
||||
},
|
||||
"ports_description": {
|
||||
"80/tcp": "Web interface (Not required for Ingress)"
|
||||
},
|
||||
"map": [
|
||||
"config",
|
||||
"share",
|
||||
"ssl"
|
||||
],
|
||||
"options": {
|
||||
"ssl": true,
|
||||
"certfile": "fullchain.pem",
|
||||
"keyfile": "privkey.pem"
|
||||
},
|
||||
"schema": {
|
||||
"log_level": "list(trace|debug|info|notice|warning|error|fatal)?",
|
||||
"ssl": "bool",
|
||||
"certfile": "str",
|
||||
"keyfile": "str",
|
||||
"leave_front_door_open": "bool?"
|
||||
},
|
||||
"image": "ghcr.io/hassio-addons/log-viewer/{arch}"
|
||||
}
|
||||
BIN
log-viewer/icon.png
Normal file
BIN
log-viewer/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.3 KiB |
BIN
log-viewer/logo.png
Normal file
BIN
log-viewer/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.3 KiB |
22
log-viewer/translations/en.yaml
Normal file
22
log-viewer/translations/en.yaml
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
configuration:
|
||||
log_level:
|
||||
name: Log level
|
||||
description: >-
|
||||
Controls the level of log details the add-on provides.
|
||||
ssl:
|
||||
name: SSL
|
||||
description: >-
|
||||
Enables/Disables SSL (HTTPS) on the web interface.
|
||||
certfile:
|
||||
name: Certificate file
|
||||
description: >-
|
||||
The certificate file to use for SSL. Note that this file must
|
||||
exist in the /ssl/ folder.
|
||||
keyfile:
|
||||
name: Private key file
|
||||
description: >-
|
||||
The private key file to use for SSL. Note that this file must
|
||||
exist in the /ssl/ folder.
|
||||
network:
|
||||
80/tcp: Web interface (Not required for Ingress)
|
||||
Reference in New Issue
Block a user