Linux installation instructions: Add sudo configuration section

Change-type: patch
This commit is contained in:
Paulo Castro 2021-03-06 21:48:19 +00:00
parent 4bfd345b68
commit b233ea3e3e
3 changed files with 39 additions and 22 deletions

View File

@ -11,35 +11,52 @@ Selected operating system: **Linux**
with "-standalone.zip", for example: with "-standalone.zip", for example:
`balena-cli-vX.Y.Z-linux-x64-standalone.zip` `balena-cli-vX.Y.Z-linux-x64-standalone.zip`
2. Extract the zip file contents to any folder you choose. The extracted contents will include a 2. Extract the zip file contents to any folder you choose, for example `/home/james`.
`balena-cli` folder. The extracted contents will include a `balena-cli` folder.
3. Add the `balena-cli` folder to the system's `PATH` environment variable. There are several 3. Add that folder (e.g. `/home/james/balena-cli`) to the `PATH` environment variable.
ways of achieving this on Linux: See this [StackOverflow post](https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux-unix). Close and reopen the terminal window Check this [StackOverflow
so that the changes to PATH can take effect. post](https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux-unix)
for instructions. Close and reopen the terminal window so that the changes to `PATH`
can take effect.
4. Check that the installation was successful by running the following commands on a 4. Check that the installation was successful by running the following commands on a
command terminal: terminal window:
* `balena version` - should print the CLI's version * `balena version` - should print the CLI's version
* `balena help` - should print a list of available commands * `balena help` - should print a list of available commands
No further steps are required to run most CLI commands. The `balena ssh`, `scan`, `build`,
`deploy` and `preload` commands may require additional software to be installed, as described
below.
To update the balena CLI to a new version, download a new release zip file and replace the previous To update the balena CLI to a new version, download a new release zip file and replace the previous
installation folder. To uninstall, simply delete the folder and edit the PATH environment variable installation folder. To uninstall, simply delete the folder and edit the PATH environment variable
as described above. as described above.
## sudo configuration
A few CLI commands require execution through sudo, e.g. `sudo balena scan`.
If your Linux distribution has an `/etc/sudoers` file that defines a `secure_path`
setting, run `sudo visudo` to edit it and add the balena CLI's installation folder to
the ***pre-existing*** `secure_path` setting, for example:
```text
Defaults secure_path="/home/james/balena-cli:<pre-existing entries go here>"
```
If an `/etc/sudoers` file does not exist, or if it does not contain a pre-existing
`secure_path` setting, do not change it.
If you also have Docker installed, ensure that it can be executed ***without*** `sudo`, so that
CLI commands like `balena build` and `balena preload` can also be executed without `sudo`.
Check Docker's [post-installation
steps](https://docs.docker.com/engine/install/linux-postinstall/) on how to achieve this.
## Additional Dependencies ## Additional Dependencies
### build, deploy ### build, deploy
These commands require [Docker](https://docs.docker.com/install/overview/) or These commands require [Docker](https://docs.docker.com/install/overview/) or
[balenaEngine](https://www.balena.io/engine/) to be available (on a local or remote machine). Most [balenaEngine](https://www.balena.io/engine/) to be available (on a local or remote
users will simply follow [Docker's installation machine). Most users will follow [Docker's installation
instructions](https://docs.docker.com/install/overview/) to install Docker on the same laptop (dev instructions](https://docs.docker.com/install/overview/) to install Docker on the same
machine) where the balena CLI is installed. The [advanced installation workstation (laptop) as the balena CLI. The [advanced installation
options](./INSTALL-ADVANCED.md) document describes other possibilities. options](./INSTALL-ADVANCED.md) document describes other possibilities.
### balena ssh ### balena ssh

View File

@ -29,10 +29,10 @@ and `preload` commands may require additional software to be installed, as descr
### build and deploy ### build and deploy
These commands require [Docker](https://docs.docker.com/install/overview/) or These commands require [Docker](https://docs.docker.com/install/overview/) or
[balenaEngine](https://www.balena.io/engine/) to be available (on a local or remote machine). Most [balenaEngine](https://www.balena.io/engine/) to be available (on a local or remote
users will simply follow [Docker's installation machine). Most users will follow [Docker's installation
instructions](https://docs.docker.com/install/overview/) to install Docker on the same laptop (dev instructions](https://docs.docker.com/install/overview/) to install Docker on the same
machine) where the balena CLI is installed. The [advanced installation workstation (laptop) as the balena CLI. The [advanced installation
options](./INSTALL-ADVANCED.md) document describes other possibilities. options](./INSTALL-ADVANCED.md) document describes other possibilities.
### balena ssh ### balena ssh

View File

@ -30,10 +30,10 @@ described below.
### build and deploy ### build and deploy
These commands require [Docker](https://docs.docker.com/install/overview/) or These commands require [Docker](https://docs.docker.com/install/overview/) or
[balenaEngine](https://www.balena.io/engine/) to be available (on a local or remote machine). Most [balenaEngine](https://www.balena.io/engine/) to be available (on a local or remote
users will simply follow [Docker's installation machine). Most users will follow [Docker's installation
instructions](https://docs.docker.com/install/overview/) to install Docker on the same laptop (dev instructions](https://docs.docker.com/install/overview/) to install Docker on the same
machine) where the balena CLI is installed. The [advanced installation workstation (laptop) as the balena CLI. The [advanced installation
options](./INSTALL-ADVANCED.md) document describes other possibilities. options](./INSTALL-ADVANCED.md) document describes other possibilities.
### balena ssh ### balena ssh