Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 3.64 KB

info.md

File metadata and controls

68 lines (48 loc) · 3.64 KB

Home Assistant VSCode Tunel logo

Home Assistant VSCode Tunnel

GitHub Release GitHub Activity License

hacs Project Maintenance BuyMeCoffee

Community Forum

This component will set up the following platforms.

Platform Description
switch VSCode tunnel in your HA Docker container. Turn it on/off with the switch

{% if not installed %}

HACS Installation

  1. Install the custom component from HACS.
  2. Restart Home Assistant.
  3. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Home Assistant VSCode Tunnel".
  4. Follow the installation instructions. Authenticating with github is required.
  5. Restart Home Assistant
  6. Turn on the VSCode Tunnel Switch entity to start the tunnel.
  7. Go to https://vscode.dev/your_tunnel_name to access your home assistant files (configuartion.yaml, etc)
  8. Turn off the VScode Tunnel Switch if you want to stop the tunnel and the associated external connection.

https://vscode.dev can't be opened in an iframe, so this will not work as a sidebar menu item in home assistant - YET! Apparently this feature has been requested and hopefully will be available soon! (see microsoft/vscode#150152)

{% endif %}

Configuration is done in the UI

If you are having trouble with authentication, increase the timeout in the options.

If you are experiencing a "reload error" after browsing to https://vscode.dev/your_tunnel_name, ensure that you have "turned on" the switch in your home assistant instance. If you are still having difficulties browse to https://vscode.dev and select you tunnel instance from the workspace dropdown menu at the top of the page.

Credits

This project was generated from @oncleben31's Home Assistant Custom Component Cookiecutter template.

Code template was mainly taken from @Ludeeus's integration_blueprint template