diff --git a/source/_includes/common-tasks/file_access.md b/source/_includes/common-tasks/file_access.md index d84f669c218..f5d13a7c62f 100644 --- a/source/_includes/common-tasks/file_access.md +++ b/source/_includes/common-tasks/file_access.md @@ -4,7 +4,7 @@ Your Home Assistant Operating server includes two repositories by default: The o One of the first things to take care of after installing Home Assistant OS is to provide yourself access to files. There are several add-ons commonly used for this, and most users employ a mix of various add-ons. Default directories on the host are mapped to the add-ons so that they can be accessed by the services any particular add-on might provide. On the host system these directories exist on the `/data` partition at `/mnt/data/supervisor/`. -Using any of the add-ons listed below,the following directories are made available for access: +Using any of the add-ons listed below, the following directories are made available for access: - `addons` - `backup` @@ -47,15 +47,32 @@ The Terminal & SSH add-on also provides a web terminal which allows you to acces ### Installing and using the Visual Studio Code (VSC) add-on -The Visual Studio Code add-on provides access through a feature packed web-based version of the Visual Studio Code editor and currently only supports AMD64 and aarch64/ARM64 machines. This add-on can be installed in the add-on store from the Community add-on repository. The add-on also provides access to the Home Assistant Command Line Interface (CLI) using VSC's built in terminal, which allows for checking logs, stopping and starting Home Assistant and add-ons, creating/restoring backups, and more. (See [Home Assistant via Command Line](https://www.home-assistant.io/hassio/commandline/) for further info). +The **Studio Code Server** add-on provides access through a feature-packed web-based version of the Visual Studio Code editor. It currently only supports AMD64 and aarch64/ARM64 machines. The add-on also provides access to the Home Assistant Command Line Interface (CLI) using VSC's built-in terminal, which allows for checking logs, stopping, and starting Home Assistant and add-ons, creating/restoring backups, and more. (See [Home Assistant via Command Line](/hassio/commandline/) for further info). -There is no configuration required for editing files within your `/config` directory. In order to enable access to other directories, it is necessary to edit the add-on's configuration from its configuration tab. See the add-on documentation for details. +

+Screenshot of an example of a configuration.yaml file, accessed using the File editor add-on on a Home Assistant Operating System installation. +Example of a configuration.yaml file, accessed using the Studio Code Server add-on on a Home Assistant Operating System installation. +

+ +To install and use the **Studio Code Server** in Home Assistant, follow these steps: + +1. To install the add-on, go to {% my supervisor_addon title="**Settings** > **Add-ons** > **Studio Code Server**" addon="a0d7b954_vscode" %} and install the add-on. +2. Once you have the add-on installed, if you want, select the **Show in sidebar** option. Then, select **Start**. +3. For information on configuration settings, open the **Documentation** tab. +4. To start browsing, on the **Info** tab, select **Open Web UI**. --- ### Installing and using the File Editor add-on -The File Editor add-on is a web-based file system browser and text editor. It is a more basic and light weight alternative to Visual Studio Code. YAML files are automatically checked for syntax errors while editing. To install and use the File Editor in Home Assistant, follow these steps: +The **File Editor** add-on is a web-based file system browser and text editor. It is a more basic and light weight alternative to Visual Studio Code. YAML files are automatically checked for syntax errors while editing. + +

+Screenshot of an example of a configuration.yaml file, accessed using the File editor add-on on a Home Assistant Operating System installation. +Example of a configuration.yaml file, accessed using the File editor add-on on a Home Assistant Operating System installation. +

+ +To install and use the File Editor in Home Assistant, follow these steps: 1. To install the add-on, go to {% my supervisor_addon title="**Settings** > **Add-ons** > **File editor**" addon="core_configurator" %}. - Once you have the add-on installed, you can edit files within your `/config` directory. diff --git a/source/images/docs/configuration/config-yaml_via-vscode.png b/source/images/docs/configuration/config-yaml_via-vscode.png new file mode 100644 index 00000000000..cf85a40a014 Binary files /dev/null and b/source/images/docs/configuration/config-yaml_via-vscode.png differ