Skip to content

Commit 5dde1fe

Browse files
author
Corentin Mors
authored
Document SSO authentication and Backup command (#173)
1 parent 0b67a82 commit 5dde1fe

File tree

3 files changed

+38
-2
lines changed

3 files changed

+38
-2
lines changed

documentation/pages/personal/_meta.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
"authentication": "Authentication",
44
"devices": "Managing your Devices",
55
"vault": "Accessing your Vault",
6-
"secrets": "Load secrets"
6+
"secrets": "Load secrets",
7+
"backup": "Backup your local Vault"
78
}

documentation/pages/personal/authentication.mdx

+16-1
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,25 @@ dcli sync
1111
Authenticating to your personal vault requires your email.
1212
You will be then asked to validate a second factor to register the CLI to your account.
1313

14+
## Supported primary authentication methods
15+
16+
- Master Password
17+
- SSO (self-hosted only)
18+
1419
<Callout type="warning" emoji="⚠️">
15-
SSO authentication is not supported yet.
20+
Confidential SSO (using Nitro Enclaves) and Password-Less authentication are not supported yet.
1621
</Callout>
1722

23+
### Requirements for SSO authentication
24+
25+
You must have:
26+
27+
- the [latest Chrome browser](https://support.google.com/chrome/answer/95346) installed on your machine
28+
- a visual interface to be able to authenticate in the browser
29+
- a machine that has a keychain (macOS, Windows, Linux with libsecret installed for instance)
30+
31+
The CLI will open a new **incognito** tab to authenticate you to your SSO provider.
32+
1833
## Supported 2FA methods
1934

2035
- Email code validation (default)
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Backup your local Vault
2+
3+
By using the `backup` command, you can backup your local vault to a given directory and filename.
4+
The command will perform a sync prior to the backup to ensure that the latest data is pulled from the Dashlane servers.
5+
6+
The backup is a [sqlite3](https://www.sqlite.org/index.html) database file containing all your secrets encrypted by your master password.
7+
8+
```bash
9+
# By default the backup file is stored in the current directory and named dashlane-backup-<timestamp>.db
10+
dcli backup
11+
12+
# You can specify the directory and filename
13+
dcli backup --filename <filename> --directory <directory>
14+
```
15+
16+
The database is composed of 3 tables:
17+
18+
- `device`: contains the current device information and configuration (including your device secrets)
19+
- `transactions`: contains all the transactions that composed your vault (the type determines if the transaction is a password, a note, a credit card, etc.)
20+
- `syncUpdates`: contains the sync updates when the data was pulled from the Dashlane servers

0 commit comments

Comments
 (0)