Documentation Updates (#12373)
Added documentation updates for Browser Integration and Secret Service Integration --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Jonathan White <support@dmapps.us>
|
|
@ -37,6 +37,8 @@ include::topics/Passkeys.adoc[tags=*]
|
||||||
|
|
||||||
include::topics/AutoType.adoc[tags=*]
|
include::topics/AutoType.adoc[tags=*]
|
||||||
|
|
||||||
|
include::topics/SecretService.adoc[tags=*]
|
||||||
|
|
||||||
include::topics/SSHAgent.adoc[tags=*]
|
include::topics/SSHAgent.adoc[tags=*]
|
||||||
|
|
||||||
include::topics/Reference.adoc[tags=*]
|
include::topics/Reference.adoc[tags=*]
|
||||||
|
|
|
||||||
|
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 48 KiB |
BIN
docs/images/browser_integration_additional_attribute.png
Normal file
|
After Width: | Height: | Size: 49 KiB |
BIN
docs/images/browser_integration_clear_sites.png
Normal file
|
After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 77 KiB |
BIN
docs/images/secretservice_access_dialog.png
Normal file
|
After Width: | Height: | Size: 26 KiB |
BIN
docs/images/secretservice_database_settings.png
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
docs/images/secretservice_enable_settings.png
Normal file
|
After Width: | Height: | Size: 55 KiB |
|
|
@ -107,12 +107,34 @@ You can then choose to update/add the credentials to your KeePassXC database dir
|
||||||
4. When you have successfully submitted the password on the website, a popup will appear asking you to either update an existing entry or add a new one.
|
4. When you have successfully submitted the password on the website, a popup will appear asking you to either update an existing entry or add a new one.
|
||||||
|
|
||||||
// tag::advanced[]
|
// tag::advanced[]
|
||||||
=== Browser statistics
|
=== Browser Integration Report
|
||||||
You can see a cross-section of all browser-related settings applied to entries within a database through the Browser Statistics report. To access these, use the _Database_ -> _Database reports..._ menu option then click on _Browser Statistics_ on the left-hand menu. From here you can see all entries with URLs applied to them, explicitly allowed and denied URLs, and any entries with custom browser settings.
|
You can see a cross-section of all browser-related settings applied to entries within a database through the Browser Statistics report. To access, use the _Database_ -> _Database reports..._ menu option then click on _Browser Statistics_ on the left-hand menu. From here you can see all entries with URLs applied to them, explicitly allowed and denied URLs, and any entries with custom browser settings.
|
||||||
|
|
||||||
.Browser statistics
|
TIP: You can delete remembered site settings from the report by right clicking the entry you want to reset and selecting "Delete plugin data from entry".
|
||||||
|
|
||||||
|
.Browser Integration Report
|
||||||
image::browser_statistics.png[]
|
image::browser_statistics.png[]
|
||||||
|
|
||||||
|
=== Additional Fill-In Fields
|
||||||
|
Sometimes login pages have additional fields you would like to fill (e.g., account number). Use the following instructions to add them:
|
||||||
|
|
||||||
|
1. Edit the entry you want to add fields to. Go to the advanced tab and add the attributes you need. Each attribute *must start with* `KPH:`, but otherwise the name does not matter. If multiple KPH attributes are defined, they are used in alphabetical order (i.e., the order shown in KeePassXC).
|
||||||
|
2. Within the browser, navigate to the page you want to use the additional fields on. Select the "Choose Custom Login Fields" button from the extension popup window. Choose Username, Password and String Field(s). Confirm the selections.
|
||||||
|
3. Refresh the web page. The new KPH attribute(s) should be filled to the extra fields.
|
||||||
|
|
||||||
|
.String Fields Selection in Browser
|
||||||
|
image:browser_integration_additional_attribute.png[]
|
||||||
|
|
||||||
|
=== Clearing Remembered Sites
|
||||||
|
Entries that you have chosen to remember allow/deny rules are stored in their respect custom data fields. You can clear all of these remembered settings at once through the database settings. Follow these steps:
|
||||||
|
|
||||||
|
1. Go to *Database* → *Database Settings* or click the database settings icon in the toolbar.
|
||||||
|
2. Go to the *Browser Integration* tab, then click on the *Forget all site-specific settings on entries* button.
|
||||||
|
3. Confirm this action in the popup dialog. This cannot be undone once the database is saved.
|
||||||
|
+
|
||||||
|
.Clear Remembered Sites
|
||||||
|
image::browser_integration_clear_sites.png[,100%]
|
||||||
|
|
||||||
=== Advanced Usage
|
=== Advanced Usage
|
||||||
You can configure unique browser integration behavior for each entry. This allows you to add multiple URLs to an entry, hide an entry from the browser integration, and more. To access these settings, open an entry for editing then click on _Browser Integration_ option in the left-hand menu *(1)*.
|
You can configure unique browser integration behavior for each entry. This allows you to add multiple URLs to an entry, hide an entry from the browser integration, and more. To access these settings, open an entry for editing then click on _Browser Integration_ option in the left-hand menu *(1)*.
|
||||||
|
|
||||||
|
|
|
||||||
48
docs/topics/SecretService.adoc
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
= KeePassXC – Secret Service Integration
|
||||||
|
include::.sharedheader[]
|
||||||
|
:imagesdir: ../images
|
||||||
|
|
||||||
|
// tag::content[]
|
||||||
|
== Secret Service Integration
|
||||||
|
This feature allows KeePassXC to act as a Secret Service provider over DBus. It enables applications to store and retrieve secrets securely via the https://www.freedesktop.org/wiki/Specifications/secret-storage-spec/[Secret Storage specification]. While running, KeePassXC acts as a Secret Service server registered on DBus so clients like seahorse, python-secretstorage, secret-tool, or other implementations can connect and access the exposed database in KeePassXC.
|
||||||
|
|
||||||
|
=== Enabling the Integration
|
||||||
|
Only one secret service provider can be enabled at a time. You may have to disable other providers, such as GNOME Keyring or KWallet, to use KeePassXC as a secret service provider. You will see a notice when attempting to enable KeePassXC as the secret service provider if another is already running.
|
||||||
|
|
||||||
|
To replace most third party secret service providers with KeePassXC, run the following shell snippet:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
mkdir -p "${XDG_DATA_HOME:-${HOME}/.local/share}/dbus-1/services"
|
||||||
|
cat > "${XDG_DATA_HOME:-${HOME}/.local/share}/dbus-1/services/org.freedesktop.secrets.service" <<EOF
|
||||||
|
[D-BUS Service]
|
||||||
|
Name=org.freedesktop.secrets
|
||||||
|
Exec=/usr/bin/keepassxc
|
||||||
|
EOF
|
||||||
|
```
|
||||||
|
|
||||||
|
NOTE: You may need to restart your session or log out and back in for the changes to take effect.
|
||||||
|
|
||||||
|
1. Open KeePassXC → **Tools → Settings → Secret Service Integration** → check **Enable KeePassXC Freedesktop.org Secret Service Integration**. Then press OK to save this setting and enable the integration. Go back into this settings screen to see currently open databases that you can unlock and edit their exposure to secret service.
|
||||||
|
+
|
||||||
|
.Secret Service Settings
|
||||||
|
image::secretservice_enable_settings.png[]
|
||||||
|
|
||||||
|
2. Either click the pencil icon in the previous settings screen, or go to **Database → Database Settings → Secret Service Integration**. Enable **Expose entries under this group**, and select the desired group. All entries within this group and all subgroups will be exposed to the service.
|
||||||
|
+
|
||||||
|
.Secret Service Database Settings
|
||||||
|
image::secretservice_database_settings.png[]
|
||||||
|
|
||||||
|
3. Use apps that integrate with secret service to start saving and using credentials within KeePassXC. If you enabled confirmation prior to access, you will see the following dialog:
|
||||||
|
+
|
||||||
|
.Secret Service Access Confirmation Dialog
|
||||||
|
image::secretservice_access_dialog.png[]
|
||||||
|
|
||||||
|
TIP: When applications use `secret-tool` and you have access confirmation enabled, then you will be prompted each time credentials are requested. This is due to `secret-tool` obtaining a new process id each time it is run.
|
||||||
|
|
||||||
|
=== Implementation Details
|
||||||
|
|
||||||
|
* The user can specify the database and group that is exposed to the service.
|
||||||
|
* Desktop notifications when a secret is retrieved and access confirmation dialogs.
|
||||||
|
* `FdoSecrets::Service` is the top level DBus service. There is one `FdoSecrets::Collection` per opened database tab and each entry under the exposed database group has a corresponding `FdoSecrets::Item` DBus object.
|
||||||
|
* The following entry attributes are exposed to the secret service: Title, Username, Password, URL, Notes, TOTP, and non-protected Custom Attributes.
|
||||||
|
// end::content[]
|
||||||
|
|
@ -18,7 +18,16 @@ image::main_interface.png[]
|
||||||
|
|
||||||
*(D) Preview* – Shows a preview of the selected group or entry. You can interact with most information stored in an entry from here without opening the entry for editing. You can temporarily hide this preview using the down-arrow button on the right hand side or completely disable it from the View menu.
|
*(D) Preview* – Shows a preview of the selected group or entry. You can interact with most information stored in an entry from here without opening the entry for editing. You can temporarily hide this preview using the down-arrow button on the right hand side or completely disable it from the View menu.
|
||||||
|
|
||||||
TIP: You can enable double-click copying of entry username and password in the Application Security Settings. This is turned off by default starting with version 2.7.0.
|
[TIP]
|
||||||
|
====
|
||||||
|
Starting with version 2.7.0, double-click copying of entry usernames and passwords is disabled by default.
|
||||||
|
|
||||||
|
To enable it:
|
||||||
|
|
||||||
|
. Open *KeePassXC*, and navigate to *Tools* → *Settings*.
|
||||||
|
. In the left sidebar, select *General*.
|
||||||
|
. Under *Entry Management*, check the box for _"Copy data on double clicking field in entry view"_.
|
||||||
|
====
|
||||||
|
|
||||||
=== Toolbar
|
=== Toolbar
|
||||||
The toolbar provides a quick way to perform common tasks with your database. Some entries in the toolbar are dynamically disabled based on the information contained in the selected entry. Every common action in KeePassXC can be controlled with a keyboard shortcut as well.
|
The toolbar provides a quick way to perform common tasks with your database. Some entries in the toolbar are dynamically disabled based on the information contained in the selected entry. Every common action in KeePassXC can be controlled with a keyboard shortcut as well.
|
||||||
|
|
|
||||||