diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index a0f47cb6..14f3a92b 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,11 +1,16 @@ -- **Cli version:** -- **Standalone install:** yes/no -- **Node version:** -- **Npm version:** -- **Operating system and architecture:** +- **balena CLI version:** e.g. 11.2.1 (output of the `"balena version"` command) +- **Operating system version:** e.g. Windows 10, Ubuntu 18.04, macOS 10.14.5 +- **32/64 bit OS and processor:** e.g. 32-bit Windows on 64-bit Intel processor +- **Install method:** npm or zip or executable installer +- **If npm install, Node.js and npm version:** e.g. Node v8.16.0 and npm v6.4.1 --- -*Please keep in mind that we try to use the issue tracker of this repository for specific bug reports & CLI feature requests. General & troubleshooting questions are encouraged to be posted to the [balena forums](https://forums.balena.io) where the community can both contribute and benefit from the answers.* +*Please keep in mind that we try to use the issue tracker of this repository for specific bug +reports & CLI feature requests. General & troubleshooting questions are encouraged to be posted to +the [balena forums](https://forums.balena.io), which are monitored by balena's support team and +where the community can both contribute and benefit from the answers.* -*Before submitting this issue please check that this issue is not a duplicate. If there is another issue describing the same problem or feature please add your information to the existing issue's comments.* +*Before submitting this issue please check that this issue is not a duplicate. If there is another +issue describing the same problem or feature please add your information to the existing issue's +comments.* diff --git a/INSTALL.md b/INSTALL.md index 93ff854d..73216a20 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -75,14 +75,14 @@ If you are a Node.js developer, you may wish to install the balena CLI via [npm] The npm installation involves building native (platform-specific) binary modules, which require some additional development tools to be installed first: -* Node.js version 6 or above (**soon version 8 or above**) +* Node.js version 8 or 10 (v12 has not been thoroughly tested yet) * Python 2.7 * g++ compiler * make * git -* Under Windows, the `windows-build-tools` npm package should be installed too, running the - following command in an administrator console (available as 'Command Prompt (Admin)' when - pressing Windows+X in Windows 7+) : +* On Windows, the `windows-build-tools` npm package should be installed too, running the following + command in an administrator console (available as "Command Prompt (Admin)" or "Windows PowerShell + (Admin)" when typing Windows+X): `npm install -g --production windows-build-tools` With those in place, the CLI installation command is: @@ -95,6 +95,11 @@ $ npm install balena-cli -g --production --unsafe-perm This allows npm install steps to download and save prebuilt native binaries. You may be able to omit it, especially if you're using a user-managed node install such as [nvm](https://github.com/creationix/nvm). +On some Linux distributions like Ubuntu, users often report permission or otherwise mysterious +errors when using the system Node / npm packages installed via "apt-get". We suggest using +[nvm](https://github.com/creationix/nvm) instead. Check this sample Dockerfile for installing the +CLI on an Ubuntu Docker image: https://gist.github.com/pdcastro/5d4d96652181e7da685a32caf629dd44 + ## Additional Dependencies * The `balena ssh` command requires a recent version of the `ssh` command-line tool to be available: