Skip to content

Latest commit

 

History

History
82 lines (59 loc) · 3.32 KB

DOCS.md

File metadata and controls

82 lines (59 loc) · 3.32 KB

Home Assistant Add-on: Advanced Code Server

Code Server experience integrated in the Home Assistant frontend, allowing you to edit your Home Assistant configuration directly from your web browser.

The add-on has the Home Assistant, MDI icons and YAML extensions pre-installed and pre-configured right out of the box. This means that auto-completion works instantly, without the need for configuring anything.

Take a look here if you are looking for the original Code Server Add-on from HA Community Add-ons.

Installation

To install this Add-On, manually add the HA-Addons repository to Home Assistant using this GitHub repository or by clicking the button below.

Add Repository to HA

Preinstalled tools

  • Host Docker access
  • Material Design icons pre-installed
  • Cron installed and configured
  • Tailscale installed
  • Cloudflared installed
  • Rclone installed
  • Appdaemon & hass-apps installed
  • Custom cont-init.d and services.d scripts (see chapter below)

Configuration

Note: Remember to restart the add-on when the configuration is changed.

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.

Custom Init scripts

The add-on will generate the relevant folders where you can place your s6-rc v3 scripts. /addon_configs/xxxxxxxx_code-server/custom-services

Check the s6 manual for more information on how to write s6-rc scripts.

Note: Please be aware that this is a really powerful function which can damage your whole system if handled incorrectly.

Note: If your custom scripts prevent the add-on from starting set log_level to debug to temporarily disable your init scripts from running.

Resetting your Code Server settings to the add-on defaults

The add-on updates your settings to be optimized for use with Home Assistant. As soon as you change a setting, the add-on will stop doing that since it might be destructive. However, in case you changed some things, but want to return to the defaults as delivered by this add-on, do the following:

  1. Open the Visual Studio Code editor.
  2. Click on Terminal in the top menu bar and clik on New Terminal.
  3. Execute the following command in the terminal window: reset-settings.
  4. Done!