ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2024-12-18 21:27:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add Windows-specific hint to 'balena scan' output

Browse Source 
An extra Windows-specific message is now appended to the 'Could not find any balenaOS devices' message - if the OS is Windows.

Also updated the INSTALL instructions with details of the dependency on Bonjour.

Change-type: patch
Signed-off-by: Graham McCulloch <graham@balena.io>
This commit is contained in:
Graham McCulloch 2020-01-09 14:34:27 -08:00
parent cd6072ac73
commit aca794b267
2 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
INSTALL.md
View File

@ -170,6 +170,14 @@ especially if you're using a user-managed node install such as [nvm](https://git
Windows, check the [FAQ item "Docker seems to be Windows, check the [FAQ item "Docker seems to be
unavailable"](https://github.com/balena-io/balena-cli/blob/master/TROUBLESHOOTING.md#docker-seems-to-be-unavailable-error-when-using-windows-subsystem-for-linux-wsl). unavailable"](https://github.com/balena-io/balena-cli/blob/master/TROUBLESHOOTING.md#docker-seems-to-be-unavailable-error-when-using-windows-subsystem-for-linux-wsl).
* The `balena scan` command requires a multicast DNS (mDNS) service like Bonjour or Avahi:
* On Windows, check if 'Bonjour' is installed (Control Panel > Programs and Features).
If not, you can download Bonjour for Windows from https://support.apple.com/kb/DL999
* Most 'desktop' Linux distributions ship with [Avahi](https://en.wikipedia.org/wiki/Avahi_(software)).
Search for the installation command for your distribution. E.g. for Ubuntu:
`sudo apt-get install avahi-daemon`
* macOS comes with [Bonjour](https://en.wikipedia.org/wiki/Bonjour_(software)) built-in.
## Configuring SSH keys ## Configuring SSH keys
The `balena ssh` command requires an SSH key to be added to your balena account. If you had The `balena ssh` command requires an SSH key to be added to your balena account. If you had

16
lib/actions/scan.coffee
View File

@ -32,6 +32,20 @@ dockerVersionProperties = [
'ApiVersion' 'ApiVersion'
] ]
scanErrorMessage = 'Could not find any balenaOS devices in the local network.'
winScanErrorMessage = scanErrorMessage + """
\n
Note for Windows users:
The 'scan' command relies on the Bonjour service. Check whether Bonjour is
installed (Control Panel > Programs and Features). If not, you can download
Bonjour for Windows (included with Bonjour Print Services) from here:
https://support.apple.com/kb/DL999
After installing Bonjour, restart your PC and run the 'balena scan' command
again.
"""
module.exports = module.exports =
signature: 'scan' signature: 'scan'
description: 'Scan for balenaOS devices in your local network' description: 'Scan for balenaOS devices in your local network'
@ -82,7 +96,7 @@ module.exports =
.catchReturn(false) .catchReturn(false)
.tap (devices) -> .tap (devices) ->
if _.isEmpty(devices) if _.isEmpty(devices)
exitWithExpectedError('Could not find any balenaOS devices in the local network') exitWithExpectedError(if process.platform == 'win32' then winScanErrorMessage else scanErrorMessage)
.map ({ host, address }) -> .map ({ host, address }) ->
docker = dockerUtils.createClient(host: address, port: dockerPort, timeout: dockerTimeout) docker = dockerUtils.createClient(host: address, port: dockerPort, timeout: dockerTimeout)
Promise.props Promise.props