From 42e00434f9e091641362e6b73baa424c057e9b8b Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Mon, 29 Jan 2024 19:27:25 +0100 Subject: [PATCH] File editor: update installation procedure (#31118) --- source/_includes/common-tasks/file_access.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/source/_includes/common-tasks/file_access.md b/source/_includes/common-tasks/file_access.md index f7a3e7f464c..d84f669c218 100644 --- a/source/_includes/common-tasks/file_access.md +++ b/source/_includes/common-tasks/file_access.md @@ -55,6 +55,12 @@ There is no configuration required for editing files within your `/config` direc ### Installing and using the File Editor add-on -A more basic and light weight alternative to Visual Studio Code, the File Editor add-on provides access through Hass-Configurator, which is a web-based filesystem-browser and text-editor. YAML files are automatically checked for syntax errors while editing. This add-on can be installed via the add-on store from the official add-on repository. +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: -There is no configuration required for editing files within your `/config` directory. In order to enable access to further directories, editing the add-on configuration is required. See the add-on documentation for details. +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. +2. If you want to be able to access directories outside the `/config` directory, in the add-on, open the **Configuration** tab and disable the **Enforce basepath** option. + - Note: The **Enforce basepath** option is intended to protect you from inadvertently making changes to settings files. +3. For information on other configuration settings, open the **Documentation** tab. +4. To confirm your changes, select **Save**. +5. To start browsing, on the **Info** tab, select **Open Web UI**.