search

hassio-addons / addon-ssh

Advanced SSH & Web Terminal - Home Assistant Community Add-ons
https://addons.community
MIT License
344 stars 94 forks source link

Documentation Update - Instructions for invoking ssh addon via Hassio panel #72

Closed GaryOkie closed 5 years ago

GaryOkie commented 5 years ago

Problem/Motivation

This request is simply to update the documentation to explain how an Ingress-enabled addon can be invoked from the Hass.io panel.

Expected behavior

In particular, I am wanting to launch the latest v5 SSH addon from the Hassio 91.3 custom panel, but key parameters such as "url_path" and "ingress" are not known.

Currently I am able to launch Configurator via custom panel, using the config below, but it took a lot of searching various threads and sifting through conflicting info to find out how. Much better to just have it officially documented than ask the question in the forums and have the solution buried.

panel_custom:
  - name: hassio-main
    sidebar_title: ConfigEditor
    sidebar_icon: mdi:file-document-edit-outline
    js_url: /api/hassio/app/entrypoint.js
    url_path: configurator
    embed_iframe: true
    require_admin: true
    config:
      ingress: "core_configurator"

Proposed changes

Now that addon-SSH supports Ingress and launches quite nicely from the "Launch Web UI" link, (THANK YOU!) it would be even nicer to document how addon-SSH (and possibly other addons) can be launched directly from the Hassio panel (saving time, clicks, and simplifying the UI).

addons-assistant[bot] commented 5 years ago

:wave: Thanks for opening your first issue here! If you're reporting a :bug: bug, please make sure you include steps to reproduce it. Also, logs, error messages and information about your hardware might be usefull.

frenck commented 5 years ago

Thank you for taking the time to make a PR, I appreciate that. Nevertheless, this is a temporary workaround/solution and therefore not adding this to the documentation.

GaryOkie commented 5 years ago

Oh, so there is a some other UI capability in the works to launch addon links directly? Who would be able to provide the url_path and ingress parameters for the SSH addon so the temporary panel_custom solution would work? I've tried guessing at these, but to no avail.

frenck commented 5 years ago

Please read the announcement blog post for the Hass.io Ingress feature.

https://www.home-assistant.io/blog/2019/04/15/hassio-ingress/

Thanks.

Home Assistant
Introducing Hass.io Ingress
Ingress allows Hass.io add-ons to seamlessly integrate their user interface with Home Assistant
GaryOkie commented 5 years ago

Thanks for pointing out that doc!

For the upcoming Home Assistant 0.92 release, we will be adding support to add links to your add-ons to the Home Assistant sidebar via a toggle on the add-on details page.

Sweet! Of course I'll wait for .92. Thanks again for the assistance!

addons-assistant[bot] commented 5 years ago

This thread has been automatically locked because it has not had recent activity. Please open a new issue for related bugs and link to relevant comments in this thread.