mirror of
https://github.com/hassio-addons/repository-edge.git
synced 2025-05-06 20:21:32 +00:00
🔥 Remove VSCode Remote add-on (#49)
This commit is contained in:
Franck Nijhof
GitHub
parent
92311c2230
commit
2459a51e32
7 changed files with 0 additions and 317 deletions
22
README.md
22
README.md
|
|
@ -508,19 +508,6 @@ It is a self-hosted monitoring tool like "Uptime Robot"
|
|||
|
||||
[:books: Uptime Kuma add-on documentation][addon-doc-uptime-kuma]
|
||||
|
||||
### ✓ [VSCode Remote][addon-vscode-remote]
|
||||
|
||||
![Latest Version][vscode-remote-version-shield]
|
||||
![Supports armhf Architecture][vscode-remote-armhf-shield]
|
||||
![Supports armv7 Architecture][vscode-remote-armv7-shield]
|
||||
![Supports aarch64 Architecture][vscode-remote-aarch64-shield]
|
||||
![Supports amd64 Architecture][vscode-remote-amd64-shield]
|
||||
![Supports i386 Architecture][vscode-remote-i386-shield]
|
||||
|
||||
VSCode Remote access to Home Assistant
|
||||
|
||||
[:books: VSCode Remote add-on documentation][addon-doc-vscode-remote]
|
||||
|
||||
### ✓ [Vaultwarden (Bitwarden)][addon-bitwarden]
|
||||
|
||||
![Latest Version][bitwarden-version-shield]
|
||||
|
|
@ -1062,15 +1049,6 @@ SOFTWARE.
|
|||
[uptime-kuma-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
||||
[uptime-kuma-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
||||
[uptime-kuma-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
|
||||
[addon-vscode-remote]: https://github.com/hassio-addons/addon-vscode-remote/tree/6541b8e
|
||||
[addon-doc-vscode-remote]: https://github.com/hassio-addons/addon-vscode-remote/blob/6541b8e/README.md
|
||||
[vscode-remote-issue]: https://github.com/hassio-addons/addon-vscode-remote/issues
|
||||
[vscode-remote-version-shield]: https://img.shields.io/badge/version-6541b8e-blue.svg
|
||||
[vscode-remote-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
|
||||
[vscode-remote-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
||||
[vscode-remote-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
||||
[vscode-remote-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
||||
[vscode-remote-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
|
||||
[addon-bitwarden]: https://github.com/hassio-addons/addon-bitwarden/tree/412bd7c
|
||||
[addon-doc-bitwarden]: https://github.com/hassio-addons/addon-bitwarden/blob/412bd7c/README.md
|
||||
[bitwarden-issue]: https://github.com/hassio-addons/addon-bitwarden/issues
|
||||
|
|
|
|||
|
|
@ -1,9 +0,0 @@
|
|||
- ⬆️ Bump frenck/action-addon-information from 1.1 to 1.2 (#41)
|
||||
|
||||
Bumps [frenck/action-addon-information](https://github.com/frenck/action-addon-information) from 1.1 to 1.2.
|
||||
- [Release notes](https://github.com/frenck/action-addon-information/releases)
|
||||
- [Commits](https://github.com/frenck/action-addon-information/compare/v1.1...v1.2)
|
||||
|
||||
Signed-off-by: dependabot[bot] <support@github.com>
|
||||
|
||||
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
|
||||
|
|
@ -1,179 +0,0 @@
|
|||
# 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
|
||||
|
|
@ -1,49 +0,0 @@
|
|||
# Home Assistant Community Add-on: VSCode Remote
|
||||
|
||||
[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
|
||||
|
||||
[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
|
||||
|
||||
[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]
|
||||
|
||||
[![Support Frenck on Patreon][patreon-shield]][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.
|
||||
|
||||
## WARNING! THIS IS AN EDGE VERSION!
|
||||
|
||||
This Home Assistant Add-ons repository contains edge builds of add-ons.
|
||||
Edge builds add-ons are based upon the latest development version.
|
||||
|
||||
- They may not work at all.
|
||||
- They might stop working at any time.
|
||||
- They could have a negative impact on your system.
|
||||
|
||||
This repository was created for:
|
||||
|
||||
- Anybody willing to test.
|
||||
- Anybody interested in trying out upcoming add-ons or add-on features.
|
||||
- Developers.
|
||||
|
||||
If you are more interested in stable releases of our add-ons:
|
||||
|
||||
<https://github.com/hassio-addons/repository>
|
||||
|
||||
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||
[discord]: https://discord.me/hassioaddons
|
||||
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
||||
[forum]: https://community.home-assistant.io/?u=frenck
|
||||
[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
|
||||
[github-sponsors]: https://github.com/sponsors/frenck
|
||||
[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
|
||||
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
|
||||
[patreon]: https://www.patreon.com/frenck
|
||||
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
|
||||
[release-shield]: https://img.shields.io/badge/version-6541b8e-blue.svg
|
||||
[release]: https://github.com/hassio-addons/addon-vscode-remote/tree/6541b8e
|
||||
|
|
@ -1,58 +0,0 @@
|
|||
{
|
||||
"name": "VSCode Remote",
|
||||
"version": "6541b8e",
|
||||
"slug": "vscode-remote",
|
||||
"description": "VSCode Remote access to Home Assistant",
|
||||
"url": "https://github.com/hassio-addons/addon-vscode-remote",
|
||||
"startup": "services",
|
||||
"init": false,
|
||||
"arch": [
|
||||
"aarch64",
|
||||
"amd64",
|
||||
"armhf",
|
||||
"armv7",
|
||||
"i386"
|
||||
],
|
||||
"uart": true,
|
||||
"hassio_api": true,
|
||||
"hassio_role": "manager",
|
||||
"homeassistant_api": true,
|
||||
"map": [
|
||||
"config:rw",
|
||||
"ssl:rw",
|
||||
"addons:rw",
|
||||
"share:rw",
|
||||
"backup:rw"
|
||||
],
|
||||
"services": [
|
||||
"mysql:want",
|
||||
"mqtt:want"
|
||||
],
|
||||
"ports": {
|
||||
"22/tcp": 2222
|
||||
},
|
||||
"ports_description": {
|
||||
"22/tcp": "VSCode Remote SSH server port"
|
||||
},
|
||||
"options": {
|
||||
"password": "",
|
||||
"authorized_keys": [],
|
||||
"packages": [],
|
||||
"init_commands": []
|
||||
},
|
||||
"schema": {
|
||||
"log_level": "list(trace|debug|info|notice|warning|error|fatal)?",
|
||||
"password": "password",
|
||||
"authorized_keys": [
|
||||
"str"
|
||||
],
|
||||
"packages": [
|
||||
"str"
|
||||
],
|
||||
"init_commands": [
|
||||
"str"
|
||||
],
|
||||
"i_like_to_be_pwned": "bool?"
|
||||
},
|
||||
"image": "ghcr.io/hassio-addons/vscode-remote/{arch}"
|
||||
}
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 4.5 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 61 KiB |
Loading…
Add table
Add a link
Reference in a new issue