ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2025-01-18 18:56:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #1392 from balena-io/ssh-formatting

Browse Source 
balena-ssh: add info about remote vs local connections
This commit is contained in:
xginn8 2019-08-19 17:25:30 +02:00 committed by GitHub
commit b435a0e7ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/cli.markdown
View File

@ -944,7 +944,11 @@ If an application name is provided, all online devices in the application
will be presented, and the chosen device will then have a shell opened on
in it's service container or host OS.
For local devices, the ip address and .local domain name are supported.
For local devices, the IP address and .local domain name are supported.
If the device is referenced by IP or `.local` address, the connection
is initiated directly to balenaOS on port `22222` via an
openssh-compatible client. Otherwise, any connection initiated remotely
traverses the balenaCloud VPN.
Examples:
balena ssh MyApp
@ -956,7 +960,7 @@ Examples:
balena ssh 192.168.0.1 --verbose
balena ssh f49cefd.local my-service
Warning: 'balena ssh' requires an openssh-compatible client to be correctly
Warning: `balena ssh` requires an openssh-compatible client to be correctly
installed in your shell environment. For more information (including Windows
support) please check:
https://github.com/balena-io/balena-cli/blob/master/INSTALL.md#additional-dependencies

8
lib/actions/ssh.ts
View File

@ -186,7 +186,11 @@ export const ssh: CommandDefinition<
will be presented, and the chosen device will then have a shell opened on
in it's service container or host OS.
For local devices, the ip address and .local domain name are supported.
For local devices, the IP address and .local domain name are supported.
If the device is referenced by IP or \`.local\` address, the connection
is initiated directly to balenaOS on port \`22222\` via an
openssh-compatible client. Otherwise, any connection initiated remotely
traverses the balenaCloud VPN.
Examples:
balena ssh MyApp
@ -198,7 +202,7 @@ export const ssh: CommandDefinition<
balena ssh 192.168.0.1 --verbose
balena ssh f49cefd.local my-service
Warning: 'balena ssh' requires an openssh-compatible client to be correctly
Warning: \`balena ssh\` requires an openssh-compatible client to be correctly
installed in your shell environment. For more information (including Windows
support) please check:
https://github.com/balena-io/balena-cli/blob/master/INSTALL.md#additional-dependencies`,