pull/921/head
Maxim Devaev 1 year ago
parent 2c7cf7cc02
commit 2cdc9f6422

@ -10,7 +10,7 @@ All APIs are restricted to authentication. To make requests, you either need to
or get a token and pass it as a cookie with each request. or get a token and pass it as a cookie with each request.
!!! note !!! note
With enabled [2FA](auth), you will need to add the one-time code to the password without spaces. That is, if the password is `foobar` and the code is `123456`, then you need to use `foobar123456` as the password. With enabled [2FA](auth.md#two-factor-authentication), you will need to add the one-time code to the password without spaces. That is, if the password is `foobar` and the code is `123456`, then you need to use `foobar123456` as the password.
### Single request auth ### Single request auth

@ -50,7 +50,7 @@ Steb-by step to enable 2FA:
3. Install **Google Authenticator** app to your phone ([iOS](https://apps.apple.com/us/app/google-authenticator/id388497605), [Android](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2)). It will generate one-time access codes. 3. Install **Google Authenticator** app to your phone ([iOS](https://apps.apple.com/us/app/google-authenticator/id388497605), [Android](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2)). It will generate one-time access codes.
4. Configure one-time codes on PiKVM: 4. Create a secret for one-time codes on PiKVM:
``` ```
rw rw
kvmd-totp init kvmd-totp init
@ -63,3 +63,7 @@ Steb-by step to enable 2FA:
!!! note !!! note
With 2FA for API or VNC authentication, you will need to add the one-time code to the password without spaces. That is, if the password is `foobar` and the code is `123456`, then you need to use `foobar123456` as the password. With 2FA for API or VNC authentication, you will need to add the one-time code to the password without spaces. That is, if the password is `foobar` and the code is `123456`, then you need to use `foobar123456` as the password.
To view the current QR code of the secret use `kvmd-totp show`.
To disable 2FA, use `kvmd-totp del`.

@ -98,7 +98,7 @@ For future examples, let's assume that your PiKVM has received the address **192
# kvmd-htpasswd del <user> # Removes/deletes a user # kvmd-htpasswd del <user> # Removes/deletes a user
``` ```
Optionally you can enable the [two-factor athentication](auth). Optionally you can enable the [two-factor authentication](auth.md#two-factor-authentication).
## Configuring PiKVM ## Configuring PiKVM

@ -10,7 +10,7 @@ IPMI is an [old protocol](https://en.wikipedia.org/wiki/Intelligent_Platform_Man
It can be useful for managing a large number of machines with PiKVM. Its advantage is that it is supported by many enterprise systems. It can be useful for managing a large number of machines with PiKVM. Its advantage is that it is supported by many enterprise systems.
!!! warning !!! warning
Although PiKVM supports the IPMI protocol, we strongly recommend that you **DO NOT USE IT** outside of trusted networks due to the protocol's [insecurity](https://github.com/NitescuLucian/nliplace.com.blog.drafts). Use Redfish or [KVMD API](api.md) instead of it. Also IPMI can not work with [2FA](auth). Although PiKVM supports the IPMI protocol, we strongly recommend that you **DO NOT USE IT** outside of trusted networks due to the protocol's [insecurity](https://github.com/NitescuLucian/nliplace.com.blog.drafts). Use Redfish or [KVMD API](api.md) instead of it. Also IPMI can not work with [2FA](auth.md#two-factor-authentication).
To enable IPMI BMC follow these steps: To enable IPMI BMC follow these steps:

@ -43,7 +43,7 @@ As an alternative to the web interface, you can use VNC with various desktop cli
5. Switch filesystem back to read-only: `ro`. 5. Switch filesystem back to read-only: `ro`.
!!! note !!! note
With enabled [2FA](auth), you will need to add the one-time code to the password without spaces. That is, if the password is `foobar` and the code is `123456`, then you need to use `foobar123456` as the password. Also note that `vncauth` (step 3) will not work with 2FA. With enabled [2FA](auth.md#two-factor-authentication), you will need to add the one-time code to the password without spaces. That is, if the password is `foobar` and the code is `123456`, then you need to use `foobar123456` as the password. Also note that `vncauth` (step 3) will not work with 2FA.
## Configuring the client ## Configuring the client

Loading…
Cancel
Save