mirror of
https://github.com/hassio-addons/repository-edge.git
synced 2025-05-06 20:21:32 +00:00
179 lines
6.6 KiB
Markdown
179 lines
6.6 KiB
Markdown
# Home Assistant Community Add-on: VSCode Remote
|
|
|
|
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.
|
|
|
|
## Installation
|
|
|
|
The installation of this add-on is pretty straightforward and not different in
|
|
comparison to installing any other Home Assistant add-on.
|
|
|
|
1. Search for the "VSCode Remote" add-on in the Supervisor add-on store
|
|
and install it.
|
|
1. Set a password or add a SSH public key pair to the add-on configuration.
|
|
1. Start the "VSCode Remote" add-on.
|
|
1. Check the logs of the "VSCode Remote" add-on to see if everything went well.
|
|
1. Connect the Visual Studio Code on your desktop with Home Assistant.
|
|
|
|
## Configuration
|
|
|
|
**Note**: _Remember to restart the add-on when the configuration is changed._
|
|
|
|
Example add-on configuration:
|
|
|
|
```yaml
|
|
log_level: info
|
|
password: ""
|
|
authorized_keys:
|
|
- ssh-rsa AASDJKJKJFWJFAFLCNALCMLAK234234.....
|
|
packages:
|
|
- mariadb-client
|
|
init_commands:
|
|
- ls -la
|
|
```
|
|
|
|
**Note**: _This is just an example, don't copy and paste it! Create your own!_
|
|
|
|
### Option: `log_level`
|
|
|
|
The `log_level` option controls the level of log output by the addon and can
|
|
be changed to be more or less verbose, which might be useful when you are
|
|
dealing with an unknown issue. Possible values are:
|
|
|
|
- `trace`: Show every detail, like all called internal functions.
|
|
- `debug`: Shows detailed debug information.
|
|
- `info`: Normal (usually) interesting events.
|
|
- `warning`: Exceptional occurrences that are not errors.
|
|
- `error`: Runtime errors that do not require immediate action.
|
|
- `fatal`: Something went terribly wrong. Add-on becomes unusable.
|
|
|
|
Please note that each level automatically includes log messages from a
|
|
more severe level, e.g., `debug` also shows `info` messages. By default,
|
|
the `log_level` is set to `info`, which is the recommended setting unless
|
|
you are troubleshooting.
|
|
|
|
### Option: `password`
|
|
|
|
Sets the password to log in with. Leaving it empty would disable the possibility
|
|
to authenticate with a password. We would highly recommend not to use this
|
|
option from a security point of view.
|
|
|
|
**Note**: _The password will be checked against HaveIBeenPwned. If it is
|
|
listed, the add-on will not start._
|
|
|
|
### Option: `authorized_keys`
|
|
|
|
Add one or more public keys to your SSH server to use with authentication.
|
|
This is the recommended over setting a password.
|
|
|
|
Please take a look at the awesome [documentation created by GitHub][github-ssh]
|
|
about using public/private key pairs and how to create them.
|
|
|
|
**Note**: _Please ensure the keys are specified as a list._
|
|
|
|
### Option: `packages`
|
|
|
|
Allows you to specify additional [Debian packages][debian-packages] to be
|
|
installed in your shell environment (e.g., Python, PHP, Go).
|
|
|
|
**Note**: _Adding many packages will result in a longer start-up
|
|
time for the add-on._
|
|
|
|
### Option: `init_commands`
|
|
|
|
Customize your VSCode environment even more with the `init_commands` option.
|
|
Add one or more shell commands to the list, and they will be executed every
|
|
single time this add-on starts.
|
|
|
|
#### Option: `i_like_to_be_pwned`
|
|
|
|
Adding this option to the add-on configuration allows to you bypass the
|
|
HaveIBeenPwned password requirement by setting it to `true`.
|
|
|
|
**Note**: _We STRONGLY suggest picking a stronger/safer password instead of
|
|
using this option! USE AT YOUR OWN RISK!_
|
|
|
|
## Known issues and limitations
|
|
|
|
- "Visual Studio Code is unable to watch for file changes in this large
|
|
workspace" (error ENOSPC)
|
|
|
|
This issue is caused by your system not having enough file handles,
|
|
which causes VSCode to be unable to watch all your files. For HassOS,
|
|
currently the only option is to click on the little cog when the
|
|
notification appears and tell it to not show again. In case you have
|
|
a generic Linux setup (e.g., Ubuntu), follow this guide by Microsoft:
|
|
|
|
<https://code.visualstudio.com/docs/setup/linux#_visual-studio-code-is-unable-to-watch-for-file-changes-in-this-large-workspace-error-enospc>
|
|
|
|
## Changelog & Releases
|
|
|
|
This repository keeps a change log using [GitHub's releases][releases]
|
|
functionality.
|
|
|
|
Releases are based on [Semantic Versioning][semver], and use the format
|
|
of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented
|
|
based on the following:
|
|
|
|
- `MAJOR`: Incompatible or major changes.
|
|
- `MINOR`: Backwards-compatible new features and enhancements.
|
|
- `PATCH`: Backwards-compatible bugfixes and package updates.
|
|
|
|
## Support
|
|
|
|
Got questions?
|
|
|
|
You have several options to get them answered:
|
|
|
|
- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on
|
|
support and feature requests.
|
|
- The [Home Assistant Discord chat server][discord-ha] for general Home
|
|
Assistant discussions and questions.
|
|
- The Home Assistant [Community Forum][forum].
|
|
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
|
|
|
|
You could also [open an issue here][issue] GitHub.
|
|
|
|
## Authors & contributors
|
|
|
|
The original setup of this repository is by [Franck Nijhof][frenck].
|
|
|
|
For a full list of all authors and contributors,
|
|
check [the contributor's page][contributors].
|
|
|
|
## 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.
|
|
|
|
[contributors]: https://github.com/hassio-addons/addon-vscode-remote/graphs/contributors
|
|
[debian-packages]: https://packages.debian.com
|
|
[discord-ha]: https://discord.gg/c5DvZ4e
|
|
[discord]: https://discord.me/hassioaddons
|
|
[forum]: https://community.home-assistant.io/?u=frenck
|
|
[frenck]: https://github.com/frenck
|
|
[github-ssh]: https://help.github.com/articles/connecting-to-github-with-ssh/
|
|
[issue]: https://github.com/hassio-addons/addon-vscode-remote/issues
|
|
[reddit]: https://reddit.com/r/homeassistant
|
|
[releases]: https://github.com/hassio-addons/addon-vscode-remote/releases
|
|
[semver]: http://semver.org/spec/v2.0.0
|