Skip to content

Commit 27d452c

Browse files
committed
Update README
1 parent 97ef59f commit 27d452c

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ You have these options:
2626
- Setup Enviroment Variables
2727
- Provide the Flags manually every time
2828

29-
Note: userPrivateKey is the actual Private Key and not a path to a file. You can also just store the serverAddress and your Private Key, if your Password is not set it will prompt you for it every time
29+
Note: userPrivateKey is the actual Private Key and not a path to a file. You can also just store the serverAddress and your Private Key, if your Password is not set it will prompt you for it every time. MFA settings can also be save permenantly this ways
3030

3131
# Usage
3232

@@ -69,6 +69,18 @@ Note: you can supply the the users argument multiple times to share with multipl
6969

7070
For sharing with groups the `--group` argument exists.
7171

72+
# MFA
73+
you can setup MFA also using the configuration sub command, only TOTP is supported, there are mulitple modes for MFA: `none`, `interactive-totp` and `noninteractive-totp`.
74+
| Mode | Description |
75+
| --- | --- |
76+
|`none`|just errors if challanged for MFA.
77+
|`interactive-totp` | prompts for interactive entry of TOTP Codes.
78+
|`noninteractive-totp` | automatically generates TOTP Codes when challenged, it requires the `totpToken` flag to be set to your totp Secret, you can configure the behavior using the `mfaDelay`, `mfaRetrys` and `totpOffset` flags
79+
80+
81+
# Server Verification
82+
to enable Server Verification you need to run `passbolt verify` once, after that the server will always be verified if the same config is used
83+
7284
# Documentation
7385
Usage for all Subcommands is [here](https://github.com/speatzle/go-passbolt-cli/wiki/go-passbolt-cli).
7486
And is also available via `man passbolt`

0 commit comments

Comments
 (0)