Git-Mirrors/keepassxc
1
0
Fork 0
mirror of https://github.com/keepassxreboot/keepassxc.git synced 2024-12-24 23:09:44 -05:00
Code Issues Packages Projects Releases Wiki Activity

add documentation

Browse Source
This commit is contained in:
Nicolas Pardon 2023-12-03 00:23:24 +01:00
parent de1c90d244
commit f30bb3f428
2 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/images/autoopen_cmd.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 37 KiB

25
docs/topics/DatabaseOperations.adoc
View File

@ -292,21 +292,34 @@ image::edit_entry_history.png[]
NOTE: Restoring an old history item will store the current entry settings as a new history item. NOTE: Restoring an old history item will store the current entry settings as a new history item.
== Automatic Database Opening == Automatic Opening
You can setup one or more databases to open automatically when you unlock a single database. This is done by *(1)* defining a special group named `AutoOpen` with *(2)* entries that contain the file path and credentials for each database that should be opened. There is no limit to the number of databases that can be opened. You can setup either databases to open or commands to execute automatically when you unlock a single database. This is done by *(1)* defining a special group named `AutoOpen` with *(2)* entries that contain the file path and credentials for each database that should be opened or a command in the URL field starting with `cmd://`. There is no limit to the number of entries that trigger databases or commands.
TIP: Case matters with auto open, the group name must be exactly `AutoOpen` and it must be a child of the root group. TIP: Case matters with auto open, the group name must be exactly `AutoOpen` and it must be a child of the root group.
.AutoOpen Group and Entries .AutoOpen Database Group and Entries
image::autoopen.png[] image::autoopen.png[]
To setup an entry for auto open perform the following steps: To setup an entry for auto opening of a database perform the following steps:
1. Create a new entry and give it any title you wish. 1. Create a new entry and give it any title you wish.
2. If your database has a key file, enter its absolute or relative path in the `username` field. 2. If your database has a key file, enter its absolute or relative path in the `username` field.
3. If your database has a password, enter it in the `password` field 3. If your database has a password, enter it in the `password` field
4. Enter the absolute or relative path to the database file in the `url` field. You can also use the `{DB_DIR}` placeholder to reference the absolute path of the current database file. 4. Enter the absolute or relative path to the database file in the `url` field. You can also use the `{DB_DIR}` placeholder to reference the absolute path of the current database file.
5. To restrict auto open to particular devices, go to the advanced category and enter the following:
NOTE: You can setup an entry to open on double click of the URL field by prepending `kdbx://` to the relative or absolute path to the database file. You may also have to add `file://` to access network shares (e.g., `kdbx://file://share/database.kdbx`).
.AutoOpen Command Group and Entries
image::autoopen_cmd.png[]
To setup a command that should be executed on opening a database performe the following steps:
1. Create a new entry and give it any title you wish.
2. Enter the command you would like to run prepending `cmd://`
NOTE: The command will be executed as if you double clicked the URL field. You may be prompted if you want to execute the command.
To restrict auto open (both databases and commands) to particular devices, go to the advanced category and enter the following:
a. Create a new attribute named `IfDevice`. a. Create a new attribute named `IfDevice`.
b. Enter hostnames in a comma separated list to define computers that will open this database. b. Enter hostnames in a comma separated list to define computers that will open this database.
c. Prepend an exclamation mark (`!`) to explicitly exclude a device. c. Prepend an exclamation mark (`!`) to explicitly exclude a device.
@ -315,8 +328,6 @@ To setup an entry for auto open perform the following steps:
.Auto open IfDevice example .Auto open IfDevice example
image::autoopen_ifdevice.png[] image::autoopen_ifdevice.png[]
NOTE: You can setup an entry to open on double click of the URL field by prepending `kdbx://` to the relative or absolute path to the database file. You may also have to add `file://` to access network shares (e.g., `kdbx://file://share/database.kdbx`).
== Database Settings == Database Settings
At any point of time, you can change the settings for your database. To make changes to the general settings, perform the following steps: At any point of time, you can change the settings for your database. To make changes to the general settings, perform the following steps: