nkapp2 doc update #493
nkapp2 doc update #493
Conversation
|
The successful documentation build was deployed for preview: |
|
Nice! pretty good, I'll add some comments inline |
| Nitrokey App 2 is the graphical application for Nitrokey 3 devices. For Nitrokey Pro and Nitrokey Storage, use `Nitrokey App 1 <https://www.nitrokey.com/download>`__ instead. | ||
| Nitrokey App 2 is the graphical application for Nitrokey 3 devices. For Nitrokey Pro and Nitrokey Storage, use instead. | ||
|
|
||
| The Nitrokey App 2 is a graphical application designed to manage Nitrokey 3 devices. It provides a user-friendly interface for configuring FIDO2 authentication, password storage, firmware updates, and PIN management. |
There was a problem hiding this comment.
Is "password storage" the correct term? In Nitrokey App 1 we called it Password Safe. What is the correct term here?
There was a problem hiding this comment.
I'm not sure.
Is password safe is included in the password storage feature ?
Otherwise password storage is a old term and should be changed by password safe
There was a problem hiding this comment.
shoud the header of the passwords file be Password Safe then ?
|
|
||
| To use a password algorithm, go to security settings of the application you want to secure and enable two-factor authentication. Choose the “Authenticator App” or “Manual Setup” option if available. | ||
|
|
||
| The service will show a secret key. Copy this secret key to enter into your credential setup. Open the password manager app and add a new credential. Choose the algorithm you want to use and paste the secret key. Save the credential. |
There was a problem hiding this comment.
"show a secret key" this is often combined with a QR code, which is a helpful hint here for the instructions.
"Open the password manager app" ?
| @@ -23,3 +23,63 @@ Entries are divided into two categories: unprotected (shown as an open lock) and | |||
| You can choose to create a protected entry by checking the "Protect with PIN" box when adding a new entry. | |||
|
|
|||
| You also have the option to require user presence in the form of a required touch on the Nitrokey 3 to access the entry by checking the "Require User Presence" box. | |||
|
|
|||
| Store and Manage Various Credentials | |||
|
|
||
| .. figure:: ./images/TOTP-code.png | ||
|
|
||
| HOTP |
There was a problem hiding this comment.
Both sectoins TOTP and HOTP are almost identical. Also HMAC is very similar. Maybe it would be better to have a single chapter for all three but describe the differences (which are not here yet) such as when to use which method.
| Verification Requirements | ||
| ************************* | ||
|
|
||
| If a PIN has been set, it must be entered before making any changes. You are allowed only 8 attempts before lockout. |
There was a problem hiding this comment.
lockout? I think it is irrevocable.
|
The successful documentation build was deployed for preview: |
no sure about the pin managment section I merged updates with old doc cause some information are still relevant