Skip to content

Commit 3d6a6fa

Browse files
docs: document upctl.yaml credentials config (#370)
Co-authored-by: Ville Välimäki <110451292+villevsv-upcloud@users.noreply.github.com>
1 parent f330a52 commit 3d6a6fa

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

docs/index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,14 @@ On bash, the completions depend on `bash-completion` package. Install and config
223223

224224
To be able to manage your UpCloud resources, you need to configure credentials for `upctl` and enable API access for these credentials.
225225

226-
Define the credentials by setting `UPCLOUD_USERNAME` and `UPCLOUD_PASSWORD` environment variables.
226+
Define the credentials either by setting `UPCLOUD_USERNAME` and `UPCLOUD_PASSWORD` environmental variables or `UPCLOUD_TOKEN` environment variable,
227+
or in the `upctl` config file (default `~/.config/upctl.yaml`, overridable with `--config /path/to/upctl.yaml`):
228+
229+
```yaml
230+
username: "your-username"
231+
password: "your-password"
232+
# alternatively, you can use token
233+
token: "your-token"
227234

228235
API access can be configured in the UpCloud Hub on [Account page](https://hub.upcloud.com/account/overview) for the main-account and on the [Permissions tab](https://hub.upcloud.com/people/permissions) of the People page for sub-accounts. We recommend you to set up a sub-account specifically for the API usage with its own username and password, as it allows you to assign specific permissions for increased security.
229236

0 commit comments

Comments
 (0)