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

Improve documentation regarding Windows support for os configure.

Browse Source 
Change-type: patch
Resolves: #1812
Signed-off-by: Scott Lowe <scott@balena.io>
This commit is contained in:
Scott Lowe 2020-06-25 13:57:47 +02:00
parent 4f7ea7e32a
commit b50fef8cb4
3 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
INSTALL.md
View File

@ -191,6 +191,11 @@ regular (non-root) user account, especially if using a user-managed node install
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.
* The `balena os configure` command is currently not supported on Windows natively. Windows users are advised
to install the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/about) (WSL)
with Ubuntu, and use the Linux release of the balena CLI.
## Configuring SSH keys

5
doc/cli.markdown
View File

@ -1567,6 +1567,11 @@ https://developer.gnome.org/NetworkManager/stable/nm-settings.html
The --device-api-key option is deprecated and will be removed in a future release.
A suitable key is automatically generated or fetched if this option is omitted.
Note: This command is currently not supported on Windows natively. Windows users
are advised to install the Windows Subsystem for Linux (WSL) with Ubuntu, and use
the Linux release of the balena CLI:
https://docs.microsoft.com/en-us/windows/wsl/about
Examples:
$ balena os configure ../path/rpi3.img --device 7cf02a6

5
lib/actions-oclif/os/configure.ts
View File

@ -94,6 +94,11 @@ export default class OsConfigureCmd extends Command {
https://developer.gnome.org/NetworkManager/stable/nm-settings.html
${deviceApiKeyDeprecationMsg.split('\n').join('\n\t\t')}
Note: This command is currently not supported on Windows natively. Windows users
are advised to install the Windows Subsystem for Linux (WSL) with Ubuntu, and use
the Linux release of the balena CLI:
https://docs.microsoft.com/en-us/windows/wsl/about
`;
public static examples = [
'$ balena os configure ../path/rpi3.img --device 7cf02a6',