Skip to contentMenu Download OpenVireo

Creating Your First Database

To start using OpenVireo, you need to first create a database that will store the password and other details.

To create a database, perform the following steps:

  1. Open your OpenVireo application. The first time, the start screen asks how you want to use OpenVireo; choose Use without an account for a database file of your own (see Ways to Use OpenVireo for the other choices). Click the Create Database button (A):

    welcome screen
    Create database – Welcome screen
  2. The database creation wizard appears. Enter the desired database name and a short description (optional):

    new db wizard 1
    Create database – General information
  3. Click Continue. The Encryption Settings screen appears, we don’t recommend making any changes besides increasing or decreasing the decryption time using the slider. Setting the Decryption Time slider at higher values means that the database will have higher level of protection but the time taken by the database to open will increase.

    new db wizard 2
    Create database – Encryption settings
  4. Click the Continue button. The Database Credentials screen appears, enter your desired database password. We recommend using a long, randomized password.

    new db wizard 3
    Create database – Database credentials

    (A) Open the password generator
    (B) Toggle password visibility

  5. Click Done. You will be prompted to select a location to save your database file. The database file is saved on to your computer with the default .kdbx extension. You can store your database wherever you wish, it is fully encrypted at all times preventing unauthorized access.

Storing Your Database

The database file that you create might contain highly sensitive data and must be stored in a very secure way. You must make sure that the database is always protected with a strong and long password. The database file that is protected with a strong and long password is secure and encrypted while stored on your computer or cloud storage service.

Make sure that you or someone else does not accidentally delete the database file. Deletion of the database file will result in the total loss of all your information (including all your passwords!) and a lot of inconvenience to manually retrieve your logins for various web applications. Do not share the credentials to access your database file with anyone unless you absolutely trust them (spouse, child, etc.).

Opening an Existing Database

To open an existing database, perform the following steps:

  1. Open your OpenVireo application. Click the Open existing database button (A) or select a recent database from the Recent Databases list (B).

    open database
    Open an existing database
  2. Navigate to the location of the database on your computer and open the database file. The database unlock screen will appear:

    unlock database
    Database unlock screen
  3. Enter the password for your database.

  4. (Optional) Click I have a key file (A) if you have one as an additional authentication factor for your database.

  5. (Optional) Plug in your configured YubiKey or OnlyKey to use it as an additional authentication factor. If you don’t see it listed, press the refresh button (B).

  6. Click OK. The database opens and the following screen is displayed:

    database view
    Unlocked database

Quick Unlock

On Windows and macOS, subject to hardware availability, your credentials can be securely stored to enable subsequent unlocking of your database through biometric authentication. This is enabled by default on Windows using Windows Hello and on macOS using Touch ID or Apple Watch services. You can disable this feature in the Application Settings under the Security section.

quick unlock windows hello
Windows Hello example

When your database is locked, you will see the following unlock dialog. Simply press Enter or click on Unlock Database to initiate the biometric authentication process. If you are using a hardware key (e.g. YubiKey), it must be connected to your computer to complete the unlock.

quick unlock
Quick Unlock

Entry Handling

Entries in OpenVireo are the fundamental units where all your sensitive information is stored. Each entry can contain various fields such as usernames, passwords, URLs, attachments, and notes. You can create, edit, clone, and delete entries as needed. Additionally, OpenVireo supports advanced features like TOTP for two-factor authentication, custom attributes, and entry history to track changes over time. Proper management of entries ensures that your data is organized, secure, and easily accessible when needed.

Adding an Entry

All the details such as usernames, passwords, URLs, attachments, notes, and so on are stored in database entries. You can create as many entries as you want in the database.

To add an entry, perform the following step:

  1. Click New Entry in the command bar, navigate to Entries > New Entry, or press Ctrl+N. The entry opens in a window over the database:

    edit entry
    Adding a new entry
  2. Enter a desired title for the entry, username, password, URL, and notes on this screen.

    1. Your most frequently used usernames will automatically be available in the username drop-down menu. They will also auto-complete for you when typing.

    2. You can generate a secure random password by clicking the dice icon in the password field to launch the password generator. Reveal the password by clicking the eye icon.

    3. After you add a URL to an entry you can press the download button to automatically download the website’s icon for this entry.

  3. (Optional) Add tags to the entry to quickly find it using the tags in the sidebar. You can easily add new tags or select existing ones from the drop-down list.

  4. (Optional) Select the Expires check-box to set the expiry date for the password. You can manually enter the date and time or click the Presets button to select an expiry date and time for your password.

  5. Click Save to add the entry to your database.

Editing an Entry

To edit the details in an entry, perform the following steps:

  1. Select the entry you want to edit.

  2. Press Enter, click the Edit Entry (pencil) button in the command bar, or right-click and select Edit Entry from the menu. The entry details become editable in place.

  3. Make the desired changes.

  4. Click Save in the command bar, or Cancel to discard the changes.

Adding TOTP to an Entry

Timed One-Time Passwords (TOTP) are a popular choice for two-factor authentication methods. These codes are typically six digits long and change every 30 seconds. They are derived from a shared secret value and the current time. Once set up, OpenVireo can calculate TOTP codes like any authenticator app, such as Google Authenticator. The codes can be used with copy/paste, browser extension, and Auto-Type.

To add TOTP to a database entry, you must first retrieve the secret string from the website or application you are authenticating to. Often this secret is accompanied with a QR code and can be copy/pasted below. Example:

totp code example
Example TOTP Secret

Once obtained, right-click the desired entry (1), choose TOTP → Set up TOTP…​ (2), and the setup dialog will appear. In that dialog, paste the secret code from the website (3), setup any custom settings (rare) (4), then press OK to save the settings.

totp setup
TOTP Setup Process

After an entry is configured with TOTP, you will see a clock icon in that entry’s row and have the ability to reveal the current code in the preview pane. Additionally, you can navigate to the entry’s TOTP menu to show the code in a separate window. You can also view the secret and configuration as a QR code for exporting to a mobile device. TOTP codes can be entered into forms with the browser extension, with Auto-Type by using the {TOTP} placeholder, or via menu options in the Auto-Type selection dialog.

totp usage examples
TOTP Usage

Entry Icons

You can select an icon to be displayed with each entry for easy identification. OpenVireo comes with a set of default icons that you can use or you can use your own custom icons. If you defined a URL with an entry, you can also download the favorite icon for that particular website.

edit entry icons
Entry icon selection

Deleting an Entry

To delete an entry, perform the following steps:

  1. Select the entry you want to delete and press the Del button on your keyboard.

  2. You will be prompted to move the entry to the Recycle Bin (if enabled).

  3. To permanently delete the entry, navigate to the Recycle Bin, select the entry you want to delete and press the Del button on your keyboard.

Clone an Entry

Creating a clone of an entry provides you a ready-to-use template for creating new entries with similar details of a master entry.

To create a clone of an existing entry, perform the following steps:

  1. Right-click on the entry for which you want to create a clone and select Clone Entry. Alternatively, select the desired entry and press Ctrl+K.

    clone entry
    Clone entry from context menu
  2. The clone dialog will appear.

    clone entry dialog
    Clone entry dialog
    • Select the Append ‘ - Clone’ to title check-box to create a new entry with the word Clone as the suffix to the name of the new entry.

    • Select the Replace username and password with references check-box to create the new entry where the username and the password fields contain the references to the username and password to the master entry.

    • Select the Copy history checkbox to copy the history of the master entry to the clone.

  3. If you chose to replace username and password entries with references, then the new entry will point these fields to the original entry’s values. Changing the original entry will automatically change the resolved value of the cloned entry. This is useful if you have multiple accounts for the same service that use a similar username or password combination.

    clone entry references
    References in a cloned entry
  4. You can create your own references using the Entry Reference Syntax

Entry URL Handling

OpenVireo can handle URLs in various ways. Standard URLs will be opened in your default browser. URLs that start with schemas handled by your Operating System will launch the associated application, for example ftp:// or ssh://. You can also use the following URL schemas to perform specific actions:

SchemaExampleDescription

cmd://

cmd://ssh {USERNAME}@example.com -p 2222

Launches the specified command line executable with the specified arguments. The executable must be present on your PATH or an absolute path must be specified.

kdbx://

kdbx://~/dbs/passwords.kdbx

Opens the specified database file. Set the entry’s username to the keyfile path (if required) and password to the database password. The database will open alongside the others; switch to it with the database picker.

Advanced Entry Handling

OpenVireo offers several advanced options for managing your database entries. Additional Attributes allow you to store extra information required by some applications and websites. Attachments enable you to attach files to entries, stored as encrypted binaries, which can be previewed directly in the application (text and images). Icons can be selected or downloaded for easy identification of entries. The Properties section lets you view basic properties such as creation, modification, and last accessed times, and retrieve an entry’s UUID for references. OpenVireo also maintains a history of changes to entries, allowing you to view, restore, or delete previous versions of an entry.

Additional Attributes

A lot of applications and web sites now require providing additional information when you create accounts. The additional information is used to block hackers if any suspicious activity is detected. In addition, the additional information you provide can be used to reset passwords if you forget them. You can also store arbitrary information here that can be copied to the clipboard or Auto-Typed using the {S:<ATTR_NAME>} action code.

To protect an attribute from being displayed by default, activate the Protect checkbox (A). To show the contents of the attribute while keeping it protected, press the Reveal button (B).

edit entry attributes
Additional attributes example

Attachments

You can attach files to any entry in your database by pressing the Add button (A). These files are added to the database and stored as encrypted binaries. You can open, save, or delete attachments from this interface (B).

edit entry attachments
Attachments interface

Foreground and Background Color

You can change the foreground (A) and/or background (B) color that this entry will use in the entry lists. Click the corresponding box to open the color picker dialog.

edit entry colors
Color picker dialog

Properties

OpenVireo lets you view the basic properties such as date and time of creation, modification, and when last accessed. This is also where you can retrieve an entry’s UUID for use in references.

edit entry properties
Entry properties view

History

OpenVireo maintains a history of changes you make to your entries. Each time you change an entry, OpenVireo automatically creates a backup copy of the current, non-modified entry before saving the new values. You can view the changes you made previously, restore, and delete the history of changes you made. The age of the history item, the changes that were made, and the entry’s size are shown in the table view.

  • Show: Display this history item for review, a read-only copy of the entry will be shown.

  • Restore: Reinstate the selected history item as the active entry details.

  • Delete: Delete the selected history item.

  • Delete All: Delete the entire history for this entry.

edit entry history
Entry history view

OpenVireo provides a robust search that enables you to find specific entries in the databases using different modifiers, wild card characters, and logical operators. By default, search considers the following fields when matching your query: Title, Username, URL, Tags, and Notes. To include other fields and/or narrow your search to specific fields, you can use the search syntax described below.

Modifiers and Fields

ModifierDescription

-

Exclude this term from results

!

Exclude this term from results

+

Match this term exactly

*

Term is handled as a regular expression

The following fields can be searched along with their abbreviated name in parentheses:

  • Title (t)

  • Username (u)

  • Password (p, pw)

  • URL (url)

  • Notes (n)

  • Attribute names and values (attr)

  • Attachment (attach)

  • Group (g)

  • Tags (tag)

  • Entry State (is:expired, is:weak)

Wild Card Characters and Logical Operators

Wild Card CharacterDescription

*

Match anything

?

Match one character

|

Logical OR

Sample Search Queries

The following tables lists a few samples search queries for your reference:

QueryDescription

user:johnsmith url:www.google.com

Searches the Username field for johnsmith and the URL field for www.google.com.

user:john|smith

Searches the Username field for john OR smith.

+user:johnsmith -url:www.google.com *notes:"secret note \d"

Search the username field for exactly johnsmith, the URL must not contain www.google.com, and notes contains secret note [digit].

+attr:mystring123

Searches all additional attributes for any name OR value equal to mystring123.

+tag:personal

Search exactly for the 'personal' tag and do not include tags such as 'my personal'.

is:expired is:weak

Searches for all expired entries with weak passwords.

Merging Databases

OpenVireo allows you to merge entries from one database into another through the Database → Merge From Database menu item. When merging, entries from the specified database will be imported into your currently open database. The merge process compares entries based on their unique identifiers (UUIDs) and modified timestamp. When an entry UUID matches, no matter which group it is in, the most recently modified version will be made the current and the previous version will be placed into the entry’s history. Any new entries and/or groups will be added to the open database. This feature is useful for consolidating multiple databases or synchronizing databases from conflict files in a cloud storage system.

Advanced Save Options

There are three ways that OpenVireo can handle database files. This behavior is set in the Application Settings under File Operations.

  1. (Default) Safe saves create a temporary database file alongside the existing one and atomically move it into place when all writing is complete. This prevents database corruption in the case of application crashes, loss of power, or other interruptions.

  2. Temporary file saves create a database in the temporary files folder. This database is then moved into place overtop of the existing file. Although rare, interruptions in this move process could leave your database in an unknown state. This option is useful for overcoming poorly behaved cloud sync tools.

  3. Direct-write saves write directly to the existing database file. This is an unsafe operation since any interruption can leave your entire database inaccessible. We only recommend using this option when interfacing with Linux GVFS services (e.g. Google Cloud on Gnome) and other types of storage services that host a virtual drive system.

Database Backup Options

In addition to these save options, OpenVireo can create a backup of your existing database file just prior to saving. This backup will be saved at the path specified in the Backup destination field. This path can be absolute or relative. The latter will be resolved according to the databases path. It is possible to specify a custom naming scheme with placeholders. See Backup Path Placeholders for available placeholders and examples.

save options

Alternatively, backups can be created on-demand using the Database → Save Database Backup…​ menu feature.

save database backup
Saving a database backup

Automatic Database 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.

autoopen
AutoOpen Group and Entries

To setup an entry for auto open perform the following steps:

  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.

  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.

  5. To restrict auto open to particular devices, go to the advanced category and enter the following:

    1. Create a new attribute named IfDevice.

    2. Enter hostnames in a comma separated list to define computers that will open this database.

    3. Prepend an exclamation mark (!) to explicitly exclude a device.

    4. Examples: LAPTOP, DESKTOP will auto open on a computer named LAPTOP or DESKTOP. !LAPTOP will auto open on all devices not named LAPTOP.

autoopen ifdevice
Auto open IfDevice example

The User Guide guide covers OpenVireo, based on KeePassXC 2.8.0, last updated 23 October 2026. Found a mistake? Help improve the docs on GitHub.