jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-25 10:17:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

File access: move section on SHH access to bottom (#32905)

Browse Source 
- of access section, as for new users, the other options are more likely to be used
This commit is contained in:
c0ffeeca7 2024-05-23 11:44:37 +02:00 committed by GitHub
parent d86eec1c09
commit e41edd924a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 30 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
source/_includes/common-tasks/file_access.md
View File

@ -35,32 +35,6 @@ You would then enter the IP address or hostname of your Home Assistant OS instan
---
### Installing and using the SSH add-on
If you want to use the Home Assistant command line or an SSH client, you can do this through the **Terminal & SSH** add-on.
The **Terminal & SSH** add-on provides the following functionalities:
- It provides a web terminal that you can access from the Home Assistant user interface.
- It allows you to use the Home Assistant Command Line Interface (CLI) which provides custom commands for checking logs, stopping and starting Home Assistant and add-ons, creating/restoring backups, and more.
- For a list of command line commands, refer to [Home Assistant via Command Line](/common-tasks/os#home-assistant-via-the-command-line).
- It allows connecting to your system using an SSH client.
- It also includes common tools like nano and vi editors.
- The Terminal & SSH add-on does **not provide** access to the underlying host file system.
To get started with the **Terminal & SSH** add-on, follow these steps:
1. In the bottom left, select your user to open the {% my profile title="**Profile**" %} page. Make sure **Advanced Mode** is enabled.
2. To install the add-on, go to the add-on store under [**Settings** > **Add-ons**](https://my.home-assistant.io/redirect/supervisor_addon/?addon=core_ssh) and install the **Terminal & SSH** add-on.
3. To use the web terminal, **start** the add-on, then select **Open Web UI**.
- You can now start typing your [commands](/common-tasks/os#home-assistant-via-the-command-line).
4. If you want to access from an ssh client, you need to enter credentials:
- Open the **Configuration** page.
- Enter a password or authorized Keys.
- Then save and start the add-on.
---
### Installing and using the Visual Studio Code (VSC) add-on
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).
@ -97,3 +71,29 @@ To install and use the File Editor in Home Assistant, follow these steps:
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**.
---
### Installing and using the SSH add-on
If you want to use the Home Assistant command line or an SSH client, you can do this through the **Terminal & SSH** add-on.
The **Terminal & SSH** add-on provides the following functionalities:
- It provides a web terminal that you can access from the Home Assistant user interface.
- It allows you to use the Home Assistant Command Line Interface (CLI) which provides custom commands for checking logs, stopping and starting Home Assistant and add-ons, creating/restoring backups, and more.
- For a list of command line commands, refer to [Home Assistant via Command Line](/common-tasks/os#home-assistant-via-the-command-line).
- It allows connecting to your system using an SSH client.
- It also includes common tools like nano and vi editors.
- The Terminal & SSH add-on does **not provide** access to the underlying host file system.
To get started with the **Terminal & SSH** add-on, follow these steps:
1. In the bottom left, select your user to open the {% my profile title="**Profile**" %} page. Make sure **Advanced Mode** is enabled.
2. To install the add-on, go to the add-on store under [**Settings** > **Add-ons**](https://my.home-assistant.io/redirect/supervisor_addon/?addon=core_ssh) and install the **Terminal & SSH** add-on.
3. To use the web terminal, **start** the add-on, then select **Open Web UI**.
- You can now start typing your [commands](/common-tasks/os#home-assistant-via-the-command-line).
4. If you want to access from an ssh client, you need to enter credentials:
- Open the **Configuration** page.
- Enter a password or authorized Keys.
- Then save and start the add-on.

2
source/common-tasks/os.markdown
View File

@ -3,6 +3,8 @@ title: "Common tasks - Operating System"
description: "Common tasks for Home Assistant Operating System"
installation: os
installation_name: "Operating System"
related:
- docs: /docs/configuration/
---
This section will provide guides to some common tasks and information which you will need in order to run, maintain, and edit your Home Assistant OS system. For further details on any particular subject, make sure to refer to the documentation for specific add-ons or topics listed here.

2
source/common-tasks/supervised.markdown
View File

@ -3,6 +3,8 @@ title: "Common tasks - Supervised"
description: "Common tasks for Home Assistant Supervised"
installation: supervised
installation_name: Supervised
related:
- docs: /docs/configuration/
---
## Update