Giter Club home page Giter Club logo

addon-vscode-remote's Introduction

Home Assistant Community Add-on: VSCode Remote

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

Sponsor Frenck via GitHub Sponsors

Support Frenck on Patreon

VSCode Remote access to Home Assistant.

About

A small add-on to allow to connect a VSCode client into Home Assistant, so you can access and edit your configuration with a remote Visual Studio Code instance with ease.

πŸ“š 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 Franck Nijhof.

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) 2021 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.

addon-vscode-remote's People

Contributors

dependabot[bot] avatar frenck 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

Watchers

 avatar  avatar  avatar

addon-vscode-remote's Issues

Error - Property metadata is not allowed

Problem/Motivation

Two scenes in my SCENES.YAML file are showing an error - "Property Metadata is not allowed". The scenes showing the error were created using the UI Editor. The YAML checker does not report an error in this file.

Expected behavior

No errors errors identified

Actual behavior

  metadata:  **Property metadata is not allowed**
    switch.master:
      entity_only: false
    switch.master_hallway_led:
      entity_only: false
- id: '1655321543393'
  name: GHS - Master Hallway On
  entities:
    switch.master:
      icon: mdi:light-switch
      friendly_name: Master Hallway
      state: 'on'
    switch.master_hallway_led:
      icon: mdi:led-on
      friendly_name: Master Hallway LED
      state: 'on'
  icon: mdi:ceiling-light
  metadata:  **Property metadata is not allowed**
    switch.master:
      entity_only: false
    switch.master_hallway_led:
      entity_only: false

VSCode Details;

code-server: v4.4.0
Code: 1.66.2
Commit: Unknown
Date: 2022-05-06T15:02:09.829Z
Browser: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36

Missing libatomic.so dependency

Problem/Motivation

The problem documented in #15 and solved in #16 still exists. Newer versions of VSCode will fail to run if the remote is missing libatomic.so.

Proposed changes

Re-open and merge #16

Workaround

It's possible, but sub-optimal, to work around this issue by using the following init commands

init_commands:
  - apt update
  - apt install -y libatomic1
  - 'rm -fr /tmp/* /var/{cache,log}/* /var/lib/apt/lists/*'

Unable to connect to VSCode remote addon from VSCode 1.53.2

Problem/Motivation

Unable to reconnect to pre-existing remote after upgrading to latest Windows VSCode.

VSCode log inside container includes.

node: error while loading shared libraries: libatomic.so.1: cannot open shared object file: No such file or directory

Expected behavior

Be able to reconnect to VSCode remote after local client update.

Actual behavior

Connects to remote but scrolls 'waiting for server log' in terminal. Then errors "Could not establish connection"

Steps to reproduce

Upgrade to latest VSCode for windows

Proposed changes

tested apt install libatomic1 inside addon container and could then connect so propose adding libatomic1 to apt packages included

For those still trying to use this addon

This addon hasn't been updated in a while, however it still works. The correct steps to use it are:

  1. Add HA edge repository as addon repository in de addon store: https://github.com/hassio-addons/repository-edge
  2. Install VSCode Remote addon from addon store
  3. Create SSH key pair and add it to the SSH agent on your client machine (see for example this guide)
  4. Add the public key to the config of the addon, see docs (leave password empty like password: ""):
authorized_keys:  
   - <key>
  1. In vscode on the machine you use to connect to the remote run: ctrl+shift+p --> remote-ssh: connect to remote
  2. Add new host to config with your HA ip, port 2222, user=root. For example:
IdentityFile ~/.ssh/ha_ssh_remote
Host 192.168.50.184
  HostName 192.168.50.184
  User root
  Port 2222
  1. Connect using this new config. It should work!

Good luck

Unable to connect from VSCode or command line - access denied

Problem/Motivation

I'm trying to connecto from VSCode to Home Assistent using this addon. I kjust configured a password to try things out.
I left the port on its default 2222. When trying to connect from VSCode or the command line (ssh) I'm not able to get a connection. I'm wondering which is the userid I have to pass to "ssh [email protected] -p 2222" for connecting. I tried "root", "homeassistant" and omitting a user id. In any case I get a response
homeassistant@homeassistant: Permission denied (publickey).
and the addon's logs show:
Connection closed by invalid user homeassistant 10.0.0.100 port 54207 [preauth]

Expected behavior

connection from VSCode or command line should be possible. A userid should be configuable or the docs should state which is the userId to provide for login.

Actual behavior

I can not connect due to unknown userId

Steps to reproduce

ssh [email protected] -p 2222

Proposed changes

Is this add on abandoned?

I got the same Issue as already reported and staled/closed in #59.
I guess password auth never worked since it is disabled, even if a password is provided:
PasswordAuthentication no

@frenck Is this add on abandoned? Then please archive this repo.

VS Code server addon does not start on fresh install

Problem/Motivation

Fresh installation on ProxMox with tteck script, after initial login install VS Code Server addon

Expected behavior

Start VS Code from sidebar and edit config

Actual behavior

Message telling addon is not running, please start it

error log:

Add-on version: 5.2.2
 You are running the latest version of this add-on.
 System: Home Assistant OS 8.4  (amd64 / qemux86-64)
 Home Assistant Core: 2022.8.6
 Home Assistant Supervisor: 2022.08.3
[21:06:36] INFO: Starting the code server...
[2022-08-19T19:09:04.990Z] info  Wrote default config file to ~/.config/code-server/config.yaml
[2022-08-19T19:09:20.758Z] error timed out
[21:09:23] WARNING: code-server crashed, halting add-on

Steps to reproduce

Install Home Assistant OS VM with standard settings on ProxMox 7 and after login install VS Code server

Proposed changes

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

Not in repository?

The addon doesn't seem to be in the repository (at least for me).

Is it WIP / deprecated / meant to be installed manually / error on my side?

Thanks

Cannot find the add-on in the add-on store

Problem/Motivation

Trying to follow the installation instructions which say:

Search for the "VSCode Remote" add-on in the Supervisor add-on store and install it.

Expected behavior

So I go to https://my.home-assistant.io/redirect/supervisor_store/ and type in "VSCode Remote" ...

Actual behavior

... but unfortunately, there are no results:

No results found in Official add-ons.

No results found in ESPHome.

No results found in Home Assistant Community Add-ons.

Steps to reproduce

(see above)

Proposed changes

It would be great if you could clarify the installations and/or the requirements for installing this add-on.

My system is:

Home Assistant 2022.9.6
Supervisor 2022.09.1
Operating System 9.0
Frontend 20220907.2 - latest

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.