How to connect local VSCode instance to VS Code HA Add-on via ssh?

[jaddel]

Goal: Connect my local vscode instance to the HA vscode add-on using ssh.

Setup: I’m currently running HA as a virtual appliance (x86_64/UEFI) via the qcow2 image on my unraid server.

What i did so far:

1. HA VM: Install vscode add-on
2. HA VM: Install official ssh add-on
3. Local PC: Install vscode and add the ssh extension
4. Local PC: Vscode add ssh connection:
   
   

This is how i added the connection: ssh [email protected]

5. When i try to connect i get the following error:
   
   

Could someone layout how to get this working?

Thanks

[chansearrington]

@jaddel did you figure this out?

[jaddel]

Yes I did, have a look at:

GitHub - hassio-addons/addon-vscode-remote: VSCode Remote - Home Assistant...

It‘s still under development, to make use of the addon you need to add the following link to your repository list.

https://addons.community/edge

[chansearrington]

@jaddel very cool. Thank you!

Can you share an example of your config files for

• VS Code Remote Add-on in HA Supervisor
• SSH & Web Terminal Add-on in HA Supervisor (not sure if I event need this)
• VS Code Remote extensions in VS Code
• Any Network port mappings that your had to setup

I’m trying to dev on my HA server remotely

HA is tied to nabu casa

And I also have the network my HA is on mapped to dynamic DNS.

So I typically connect with the following settings.

URL: hassio.domain.com
Port: 22
Username: root
Password: password

This works for every SSH Dev IDE I have EXCEPT VS Code

I’m a little lost between

Supervisor Add-on Settings + VS Code Remote Settings + Home Network Settings.

[jaddel]

There is the VS Code add-on and the VS Code Remote add-on which is currently still in development.
To do VS Code SSH remote dev the remote add-on is needed.

• VS Code Remote Add-on in HA Supervisor

Sure, actually all you need is to to do is add your ssh public key to the extensions config section (authorised_keys) and create a port forwarding in your router for eg. port 2222.

• SSH & Web Terminal Add-on in HA Supervisor (not sure if I event need this)

It’s not needed, the VS Code remote add-on is handling this for you.

• VS Code Remote extensions in VS Code

I haven’t set it up myself yet, but be aware that you want to do this on the code server you are connecting to (the vscode remte add-on). It’s probably pre configured but im not sure.
If you need to set it up this should guide you through the process.

Home Assistant Config Helper - Visual Studio Marketplace

Don’t forget, that the code server it self is running on the same network / docker network as Home-assistant and that it can connect locally even though you connect to the remote add-on remotely.

• Any Network port mappings that your had to setup

Port forward the ssh port you configured in the vs code remote add-on. Make sure to use ssh key authentication only.

This works for every SSH Dev IDE I have EXCEPT VS Code

This is not natively supported on Hassos, therefor you need to use the remote add-on created by Frank.

Have a look at this for a better understanding of the ssh remote dev solution by vscode.

Developing on Remote Machines using SSH and Visual Studio Code

I hope this helps.
Br Jaddel

[mietz]

I’ve created my own addon:

hassio-addons/vscode-remote-ssh at main · mietzen/hassio-addons

Since hassio-addons/addon-vscode-remote seems to be broken: Unable to connect from VSCode or command line - access denied · Issue #59 · hassio-addons/addon-vscode-remote · GitHub (I get the same error) and no one is willing to fix it.

I run daily checks for base image updates and test every image before pushing it to dockerhub.

Feel free to use it.

[AtarianComputing]

Thank you. It’s a beautiful thing.

[brandonnolet]

No hate towards @mietz, this can be achieved with the SSH & Terminal addon that many likely already have.

Here’s the required configuration parameters (everything else is à votre gout)

Visual Studio Code Remote - SSH

Some customization is required prior to being able to connect to your Home Assistant install with Visual Studio Code. The following configuration will aid in setting up VSCode Remote - SSH:

packages:
  - gcompat
  - libstdc++
  - curl
allow_remote_port_forwarding: true
allow_tcp_forwarding: true

Notes

• Allowing remote port and tcp forwarding lower the overall level of security of your SSH server. Nevertheless, this warning is debatable.
• It is not required to disable protection mode for this to work correctly.
• The Studio Code Server addon is not required for this to work correctly.
• This will not work through Home Assistant Cloud. LAN only unless you’ve exposed your server directly to the internet.

[mietz]

@brandonnolet This was the information I was searching for but never found This should be marked as solution @jaddel

[joltman]

I’m trying to get this working and I’ve got the following config in my SSH & Terminal add-on:

authorized_keys:
  - >-
    ssh-ed25519
    KEY_GOES_HERE
password: ""
apks: []
server:
  tcp_forwarding: false
  apks: []
  sftp: true
  compatibility_mode: true
packages:
  - glibc
  - gcompat
  - libstdc++
  - curl
allow_remote_port_forwarding: true
allow_tcp_forwarding: true

I’m now getting different output in my remote VS Code, but it’s a WAITING FOR SERVER LOG. VS Code is also complaining about

The remote host may not meet VS Code Server’s prerequisites for glibc and libstdc++

I must be doing something wrong, but I’m not sure what. I can SSH to the server on port 22 (what I have set in the config). Thanks for the help!

ETA:

It looks like I’ve got this working, although, I’m not sure how:

apks:
  - gcompat libstdc++ curl grep
server:
  tcp_forwarding: false
  apks: []
  sftp: true
  compatibility_mode: true
packages:
  - glibc
  - libc
  - gcompat
  - libstdc++
  - curl
  - musl
allow_remote_port_forwarding: true
allow_tcp_forwarding: true

[Shellazo]

Thanks all. This worked for me. I was banging my head against the wall trying to figure it out last night.

[chatziko (Kostas)]

The solution works for me, but although vscode connects fine, I still get the warning:

The remote host may not meet VS Code Server’s prerequisites for glibc and libstdc++

Anyone figured out how to silence the warning?

[GollyJer (Jeremy Gollehon)]

VS Code remote

Hey all. In trying to get this working I felt like it was all just throwing spagetti at a wall. So I went about figuring out how all this works. This VS Code docs page describes the prerequisite libraries preinstalled for each linux distribution. Running cat /etc/os-release in the HomeAssistant SSH terminal results in this. NAME="Alpine Linux" ID=alpine VERSION_ID=3.17.3 PRETTY_NAME="Alpine Linux v3.17" HOME_URL="https://alpinelinux.org/" BUG_REPORT_URL="https://gitlab.alpinelinux.org/alpine…

[distante]

As per October 2023 the correct way to write this config is:

authorized_keys: 
  - >- YOUR KEYS HERE
password: ""
apks:
  - gcompat
  - libstdc++
  - curl
server:
  tcp_forwarding: true

[eugene78 (Eugene)]

Hello,
I’ve managed to configure my local VS Code to use Remote SSH to connect to HA add-on.
However I’m still getting the warning on every connection:

The remote host may not meet VS Code Server’s prerequisites for glibc and libstdc++

I’ve read through these posts and tried the solutions proposed, without success.
Below is my ssh configuration for Advanced SSH & Web Terminal add-on, following distante’s proposal above.

I’ve restarted the add-on and am still getting the warning when connecting VS Code.
Do you have any suggestion to silence this warning?

Thanks in advance for your help.

username: USER
password: PASSWORD
authorized_keys:
  - >- KEYS
sftp: false
compatibility_mode: false
allow_agent_forwarding: false
allow_remote_port_forwarding: true
allow_tcp_forwarding: true
apks:
  - gcompat
  - libstdc++
  - curl
server:
  tcp_forwarding: true  // is this redundant with `allow_tcp_forwarding` above?

[xiduis15]

Hello, i read all this thread, and test all configuration but Vscode can’t connect.
I’ve still the same error message.

Waiting for server log ...
Waiting for server log ...
Waiting for server log ...

My HA version is working on VM and is up to date.
My config for add-on Terminal & SSH

[xiduis15]

i found more log in vscode console

17:06:05.952] > Waiting for server log...
[17:06:05.984] > Waiting for server log...
[17:06:06.016] >  
> *
> * Visual Studio Code Server
> *
> * By using the software, you agree to
> * the Visual Studio Code Server License Terms (https://aka.ms/vscode-server-license) and
> * the Microsoft Privacy Statement (https://privacy.microsoft.com/en-US/privacystatement).
> *
>  
[17:06:06.018] > Server did not start successfully. Full server log at /root/.vscode-server/.05047486b6df5eb8d44b2ecd70ea3bdf775fd937.log >>>
> musl libc (x86_64)
> Version 1.2.4
> Dynamic Program Loader
> Usage: /lib/ld-musl-x86_64.so.1 [options] [--] pathname
> Warning: musl detected, skipping GLIBC check
> Error relocating /root/.vscode-server/bin/05047486b6df5eb8d44b2ecd70ea3bdf775fd937/node: fcntl64: symbol not found
> <<< End of server log

[eugene78 (Eugene)]

Hello, I’m facing exactly the same issue described by @xiduis15.
The issue appeared this afternoon.
I’ve been using heavily my local VS Code connecting to VS Code HA add-on via SSH, for several weeks without any issue before this afternoon.
I updated HA from 2024.1.5 to 2024.1.6 today.
I also remember clicking on a message proposing to update VS Code today.
I’m now facing the same issue described by @xiduis15.
VS Code add-on within HA works perfectly.
Advanced SSH & Web Terminal also works.
I did a full restart of HA using the option “Reboot system: Restarts the system running Home Assistant and all add-ons”. Still facing the issue.
Current configuration:

• HA 2024.1.6.
• Studio Code Server add-on 5.15.0.
• Advanced SSH & Web Terminal add-on 17.0.4.
• VS Code desktop: Version: 1.86.0 / Commit: 05047486b6df5eb8d44b2ecd70ea3bdf775fd937

Thanks for any help.

[eugene78 (Eugene)]

Hello, FYI the issue seems to be on VS Code’s side with the 1.86.0 update.

I’ve found several issues describing the same problem on VS Code’s GitHub.
See for example:

• VS Code do not connect to any SSH Remote server #204025
• error using remote - SSH after update to 1.86.0 #204054
• couldnt run ssh #204091

EDIT: I found the exact description of the issue here:

• vscode server won’t start: “Waiting for server log…” #203967

Watching this specific issue will let us know when it’s resolved.

For the moment the solution seems to be to downgrade VS Code to 1.85.2.
I haven’t yet tried the downgrade so can’t comment further.

[eugene78 (Eugene)]

Happy to report that I’ve solved the issue by:

1. Launching my VS Code desktop version 1.86.0.
2. Downgrading the remote-ssh extension version to 0.107 from within VS Code.
3. Changing the ‘update mode’ setting to ‘none’ (will require a restart of VS Code).
4. Downloading and installing version 1.85.2 of vscode.

After following these steps, I’m now able to connect my desktop VS Code (1.85.2) to VS Code HA add-on via SSH, as I used to previously.

The underlying issue remains however: a dependency on some libraries on HA add-on’s side (minimum GLIBC >= 2.28 apparently from the comments in the GitHub issues) is preventing VS Code 1.86.0 from connecting successfully over SSH.
Hoping this issue will be fixed soon…