Giter Club home page Giter Club logo

addon-example's Introduction

Home Assistant Community Add-on: Log Viewer

GitHub Release Project Stage License

Supports aarch64 Architecture Supports amd64 Architecture Supports armhf Architecture Supports armv7 Architecture Supports i386 Architecture

Github Actions Project Maintenance GitHub Activity

Discord Community Forum

Buy me a coffee

Browser-based log utility for Home Assistant.

Log Viewer Screenshot

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.

๐Ÿ“š Read the full add-on documentation

Support

Got questions?

You have several options to get them answered:

You could also open an issue here 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 have set up a separate document containing our contribution guidelines.

Thank you for being involved! ๐Ÿ˜

Authors & contributors

The original setup of this repository is by Dale Higgs.

For a full list of all authors and contributors, check the contributor's page.

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.

License

MIT License

Copyright (c) 2018-2024 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.

addon-example's People

Contributors

dependabot[bot] avatar einschmidt avatar fabaff avatar frenck avatar ludeeus avatar renovate[bot] avatar sinclairpaul avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

addon-example's Issues

nothing happened

see only this in logs after starting

[20:43:13] INFO: Starting Example1...
./run: line 10: /usr/bin/example1.sh: Permission denied
[20:43:14] INFO: Starting Example2...
./run: line 10: /usr/bin/example2.sh: Permission denied
[20:43:14] INFO: Starting Example1...
./run: line 10: /usr/bin/example1.sh: Permission denied
[20:43:15] INFO: Starting Example2...
./run: line 10: /usr/bin/example2.sh: Permission denied
[20:43:15] INFO: Starting Example1...
./run: line 10: /usr/bin/example1.sh: Permission denied

No permission for example add-on

Problem/Motivation

Log tells me:

[17:35:42] INFO: Starting Example1... ./run: line 10: /usr/bin/example1.sh: Permission denied [17:35:42] INFO: Starting Example2... ./run: line 10: /usr/bin/example2.sh: Permission denied

I tried to restart, but there was no success for me.
Im using Hass.io 0.103 with a Rasperry Pi 3+.

Maybe someone can help?

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

dockerfile
example/Dockerfile
  • ghcr.io/hassio-addons/base 16.1.3
github-actions
.github/workflows/ci.yaml
.github/workflows/deploy.yaml
.github/workflows/labels.yaml
.github/workflows/lock.yaml
.github/workflows/pr-labels.yaml
.github/workflows/release-drafter.yaml
.github/workflows/stale.yaml
regex
example/Dockerfile
  • ghcr.io/hassio-addons/base 16.1.3
example/build.yaml
  • ghcr.io/hassio-addons/base 16.1.3
  • ghcr.io/hassio-addons/base 16.1.3
  • ghcr.io/hassio-addons/base 16.1.3
example/Dockerfile
  • alpine_3_20/coreutils 9.5-r1
  • alpine_3_20/wget 1.24.5-r0

  • Check this box to trigger a request for Renovate to run again on this repository

Where is the release drafter template (.github/release-drafter.yml)

Problem/Motivation

I built my add-on following this structure which is awesome. For the release-drafter though, I created my own very simple template. I am wondering where the template of this and other add-ons in this organisation are located, since I cannot find it in any add-on and also not in the workflow repository.

Expected behavior

Would have expected a release-drafter.yml in .github int eh repository or at least in the workflow repository

Actual behavior

Cannot find any in the whole organisation

Revise/improve all log messages

Problem/Motivation

There are several reasons for this:

  • Not all log messages are consistent across all add-ons.
  • Some messages are unclear to the novice user.

Rewrite add-on onto the S6 process supervisor

Problem/Motivation

This account currently uses a large run.sh script that bootstraps the whole add-on.
Our new base images actually contain the S6 process supervisor, which allows us the split all kinds of different add-on responsibilities in an amazing way.

Additionally, the new base images are equipped with an extensive Bash function library full of tools towards Home Assistant add-ons on S6. This will greatly reduce the amount of code and improve stability overall.

Docker cache fails to load on tags/releases

Problem/Motivation

I have forked this repository to https://github.com/a2i2/hassio-addon-pubsub and replaced the add-on content with my own. I am using the Actions in .github/workflows to build the add-on.

When I push to the main branch, the Docker cache works perfectly and the build is very quick. However, when I use GitHub Releases to produce a new release/tag, the Docker cache isn't loaded and the build is performed from scratch.

Output of the Set up build cache step:

Run actions/[email protected]
Cache not found for input keys: docker-refs/tags/v0.2.2-aarch64-66ca8825aebfda283e1368507bd197e35314a57a, docker-refs/tags/v0.2.2-aarch64

It looks like the same thing happens with this example repository:

https://github.com/hassio-addons/addon-example/runs/2380713962?check_suite_focus=true

Expected behavior

Docker cache is found and used on tagged releases

Actual behavior

Docker cache is not found on tagged releases; build is performed from scratch and takes a long time

Steps to reproduce

Create a GitHub Release, go to Actions and find the cache step and see message saying no cache was found.

Proposed changes

Not sure what the fix would be. Load the cache from edge?

Installation failure

Problem/Motivation

Installation attempt from add-on store produces the following error message:

Pulled image ghcr.io/hassio-addons/example/aarch64:4.5.0 failed on content-trust verification!

Expected behavior

Installation success

Actual behavior

Pulled image ghcr.io/hassio-addons/example/aarch64:4.5.0 failed on content-trust verification!

Steps to reproduce

Click the Install button

Proposed changes

(If you have a proposed change, workaround or fix,
describe the rationale behind it)

docker install fails after adding to my own repository

Problem/Motivation

I can install the example addon from the default repository via Android without issues (but for some reason, I don't see it on the PC web page?). But when I copy just the example folder to my own repository I get an error when I try to install. I also get the same error on one other repository that also uses some of the example as a base. sdesalve/hassio-addons#32

Expected behavior

installed the addon from my own repository just like from the default repository

Actual behavior

The command '/bin/ash -o pipefail -c apk add --no-cache coreutils=8.32-r2 wget=1.21.1-r1' returned a non-zero code: 2

Steps to reproduce

I'm using Linux Mint 19 and I did clone my and the example repository to my local drive. Next, I copied just the example folder from this cloned repository to my cloned repository. Last I push everything for my repository back to Github. In the addon store I do a reload and then I select install from my repository. I get the error and some more red text in the log.

System

System: Raspbian GNU/Linux 10 (buster) (armv7 / raspberrypi4)
Docker version 20.10.1
Home Assistant Core: 2021.1.4
Home Assistant Supervisor: 2021.01.5
Btw, I was able to install other updates to day like node red and the time server addon without issues.

Update example to use S6 services

Problem/Motivation

The example currently uses a Docker CMD instruction to start, which is fine, but that is now how all the other Community add-ons work.

This causes differences in all kinds of forked / add-ons based on this example.

Expected behavior

The example add-on to match the work method used in the Community Add-ons repositories.

Actual behavior

It differs

Proposed changes

Move the current CMD script into a service.

missing chmod on entry scripts?

Problem/Motivation

permission denied executing service scripts following addon template

(in case it matters I'm ussing the addon debian-base, not alpine

Expected behavior

it runs

Actual behavior

./run: line 6: /usr/bin/run_gateway.sh: Permission denied

Steps to reproduce

(How can someone else make/see it happen)

Proposed changes

There was previous discussion on this, but with #126 I didn't see the chmod commands carry over. Adding explicit RUN chmod a+x on my scripts successfully worked past this issue

Logging fails in example

Problem/Motivation

Trying to learn, but the example is broken

Expected behavior

Log shows quotes

Actual behavior

from plugin log
[12:14:00] INFO: Starting Example2...
./run: line 10: /usr/bin/example2.sh: Permission denied
[12:14:00] INFO: Starting Example1...
./run: line 10: /usr/bin/example1.sh: Permission denied
[12:14:01] INFO: Starting Example2...
./run: line 10: /usr/bin/example2.sh: Permission denied
[12:14:01] INFO: Starting Example1...
./run: line 10: /usr/bin/example1.sh: Permission denied
[12:14:02] INFO: Starting Example2...
./run: line 10: /usr/bin/example2.sh: Permission denied

Steps to reproduce

install plugin

Proposed changes

(If you have a proposed change, workaround or fix,
describe the rationale behind it)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.