Document new setting

This commit is contained in:
Emanuele 2020-12-21 01:11:47 +01:00
parent 552bd12d3a
commit 44a0bfe047

View file

@ -82,9 +82,13 @@ Connection parameters are provided as a dictionary with the following keys (all
| `username` | username for ssh access on reMarkable | default: `"root"` | | `username` | username for ssh access on reMarkable | default: `"root"` |
| `key` | Local path to key for ssh | not needed if password provided | | `key` | Local path to key for ssh | not needed if password provided |
| `password` | Password provided by reMarkable | not needed if key provided | | `password` | Password provided by reMarkable | not needed if key provided |
| `ask_password` | Prompt for password at launch | default: `false` |
| `timeout` | connection timeout in seconds | default: 1 | | `timeout` | connection timeout in seconds | default: 1 |
| `insecure_auto_add_host` | ignores the check on the fingerprint | default: `false` | | `insecure_auto_add_host` | ignores the check on the fingerprint | default: `false` |
The `address` parameter can be either:
- a single string, in which case the address is used for connection
- a list of strings, which will be presented at launch for selection
:warning: **Connecting after an update:** :warning: **Connecting after an update:**
An update to the reMarkable tablet would change its "fingerprint" i.e. the identifier that signals we are connecting to the expected device (and not somebody impersonating it). An update to the reMarkable tablet would change its "fingerprint" i.e. the identifier that signals we are connecting to the expected device (and not somebody impersonating it).