Skip to content

Commit

Permalink
Clarify that remote SSH access is disabled by default and expand upon… (
Browse files Browse the repository at this point in the history
home-assistant#1594)

* Clarify that remote SSH access is disabled by default and expand upon the details required to set the SSH TCP port field to enable remote SSH access

* Update ssh/DOCS.md

Co-authored-by: Franck Nijhof <[email protected]>

Co-authored-by: Franck Nijhof <[email protected]>
  • Loading branch information
deddc23efb and frenck authored Nov 4, 2020
1 parent 68675ac commit 58fc444
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions ssh/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ You can access the web terminal by clicking the "Open Web UI" button on this add

### SSH Server Connection

To connect using an SSH client, such as PuTTY, you need to supply additional configuration for this add-on. To enable SSH connectivity, you need to:
Remote SSH access from the network is disabled by default (See Network below). To connect using an SSH client, such as PuTTY or Linux terminal, you need to supply additional configuration for this add-on. To enable SSH connectivity, you need to:

- Provide authentication credentials - a password or SSH key(s)
- Specify which TCP port to bind to, on the Home Assistant host
Expand Down Expand Up @@ -76,7 +76,9 @@ Specifies whether TCP forwarding is permitted or not.

## Network

This section is only relevant if you want to connect to Home Assistant using an SSH client, such as PuTTY. To enable SSH access via the network, you need to specify which port to use on the Home Assistant host. The number you enter will be used to map that port from the host into the running "Terminal & SSH" add-on. The standard port used for the SSH protocol is `22`.
This section is only relevant if you want to connect to Home Assistant using an SSH client, such as PuTTY or Linux terminal. To enable SSH remote access from the Network, specify the desired SSH TCP server port in the Network configuration input box. The number you enter will be used to map that port from the host into the running "Terminal & SSH" add-on. The standard port used for the SSH protocol is `22`.

Remote SSH access can be disabled again, by clearing the input box, saving the configuration and restarting the add-on.

## Known issues and limitations

Expand Down

0 comments on commit 58fc444

Please sign in to comment.