Skip to content

Commit 06b7599

Browse files
committed
docs(vmm-cli): fix token file path and credential precedence order
1 parent c64861c commit 06b7599

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

docs/vmm-cli-user-guide.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,11 @@ forms.
8080
Pass the VMM API token directly; it is sent as `Authorization: Bearer <token>`.
8181

8282
```bash
83-
# the token dstackup writes, or your configured `[auth] tokens` entry
84-
export DSTACK_VMM_TOKEN=$(cat ~/.dstack/secrets/vmm-auth-token)
83+
# your VMM API token. `dstackup install` writes it to
84+
# <config-dir>/vmm-auth-token (default /etc/dstack/vmm-auth-token) — and the
85+
# local `dstack` CLI reads it automatically; a manual setup (see the VMM
86+
# configuration tutorial) stores it at ~/.dstack/secrets/vmm-auth-token.
87+
export DSTACK_VMM_TOKEN=$(cat /etc/dstack/vmm-auth-token)
8588
./vmm-cli.py lsvm
8689

8790
# or as a flag
@@ -95,18 +98,18 @@ The server also accepts HTTP Basic, where the password may be the shared token
9598

9699
```bash
97100
export DSTACK_VMM_AUTH_USER=admin
98-
export DSTACK_VMM_AUTH_PASSWORD=$(cat ~/.dstack/secrets/vmm-auth-token)
101+
export DSTACK_VMM_AUTH_PASSWORD=$(cat /etc/dstack/vmm-auth-token)
99102
./vmm-cli.py lsvm
100103

101104
# or as flags
102105
./vmm-cli.py --auth-user admin --auth-password "$DSTACK_VMM_AUTH_PASSWORD" lsvm
103106
```
104107

105-
**Note:** A bearer token takes precedence over Basic when both are set.
106-
Environment variables take precedence over command line arguments. Setting only
107-
one half of a Basic credential (e.g. `DSTACK_VMM_AUTH_PASSWORD` without
108-
`DSTACK_VMM_AUTH_USER`) is rejected with an error rather than silently sending an
109-
unauthenticated request.
108+
**Note:** A bearer token takes precedence over Basic when both are set. For each
109+
setting, command-line flags take precedence over environment variables, which
110+
take precedence over the config file. Setting only one half of a Basic
111+
credential (e.g. `DSTACK_VMM_AUTH_PASSWORD` without `DSTACK_VMM_AUTH_USER`) is
112+
rejected with an error rather than silently sending an unauthenticated request.
110113

111114

112115
## Basic Commands

0 commit comments

Comments
 (0)