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

docs: update GitHub issue template, required Node version and sample Dockerfile

Browse Source 
Resolves: #1300
Change-type: patch
Signed-off-by: Paulo Castro <paulo@balena.io>
This commit is contained in:
Paulo Castro 2019-06-13 17:21:01 +01:00
parent 46806c8377
commit 6bed43fe1f
2 changed files with 21 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
.github/ISSUE_TEMPLATE.md vendored
View File

@ -1,11 +1,16 @@
- **Cli version:** - **balena CLI version:** e.g. 11.2.1 (output of the `"balena version"` command)
- **Standalone install:** yes/no - **Operating system version:** e.g. Windows 10, Ubuntu 18.04, macOS 10.14.5
- **Node version:** - **32/64 bit OS and processor:** e.g. 32-bit Windows on 64-bit Intel processor
- **Npm version:** - **Install method:** npm or zip or executable installer
- **Operating system and architecture:** - **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.*

13
INSTALL.md
View File

@ -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 The npm installation involves building native (platform-specific) binary modules, which require
some additional development tools to be installed first: 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 * Python 2.7
* g++ compiler * g++ compiler
* make * make
* git * git
* Under Windows, the `windows-build-tools` npm package should be installed too, running the * On Windows, the `windows-build-tools` npm package should be installed too, running the following
following command in an administrator console (available as 'Command Prompt (Admin)' when command in an administrator console (available as "Command Prompt (Admin)" or "Windows PowerShell
pressing Windows+X in Windows 7+) : (Admin)" when typing Windows+X):
`npm install -g --production windows-build-tools` `npm install -g --production windows-build-tools`
With those in place, the CLI installation command is: 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, 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). 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 ## Additional Dependencies
* The `balena ssh` command requires a recent version of the `ssh` command-line tool to be available: * The `balena ssh` command requires a recent version of the `ssh` command-line tool to be available: