keepassxc/README.md
2020-07-06 18:27:15 -04:00

3.7 KiB

KeePassXC

TeamCity Build Status codecov GitHub release

KeePassXC is a modern open-source password manager. It is used to store and manage information such as URLs, usernames, passwords, and so on for various accounts on your web and desktop applications. KeePassXC stores all data in an encrypted database format while still providing secure access to that information. KeePassXC is helpful for people with extremely high demands of secure personal data management.

Quick Start

The QuickStart Guide gets you started using KeePassXC on your Windows, macOS, or Linux computer using pre-compiled binaries from the downloads page. Additionally, individual Linux distributions may ship their own versions, so please check your distribution's package list to see if KeePassXC is available. Detailed documentation is available in the User Guide.

Features List

KeePassXC has numerous features for novice and power users alike. This guide will go over the basic features to get you up and running quickly. The User Guide contains more in-depth discussions on the major features in the application.

Basic

  • Create, open, and save databases in the KDBX format (KeePass Compatible)
  • Store sensitive information in entries that are organized by groups
  • Search for entries
  • Password generator
  • Auto-Type passwords into applications
  • Browser integration with Google Chrome, Mozilla Firefox, Microsoft Edge, Chromium, Vivaldi, Brave, and Tor-Browser
  • Entry icon download
  • Import databases from CSV, 1Password, and KeePass1 formats

Advanced

  • Database reports (password health, HIBP, and statistics)
  • Database export to CSV and HTML formats
  • TOTP storage and generation
  • Field references between entries
  • File attachments and custom attributes
  • Entry history and data restoration
  • YubiKey/OnlyKey challenge-response support
  • Command line interface (keepassxc-cli)
  • Auto-Open databases
  • KeeShare shared databases (import, export, and synchronize)
  • SSH Agent
  • FreeDesktop.org Secret Service (replace Gnome keyring, etc.)
  • Additional encryption choices: Twofish and ChaCha20

For a full list of changes, read the CHANGELOG document.
For a full list of keyboard shortcuts, see KeyboardShortcuts.adoc

Building KeePassXC

Detailed instructions are available in the Build and Install page and in the Wiki.

Contributing

We are always looking for suggestions on how to improve KeePassXC. If you find any bugs or have an idea for a new feature, please let us know by opening a report in the issue tracker on GitHub or join us on IRC in freenode channels #keepassxc and #keepassxc-dev.

You may directly contribute your own code by submitting a pull request. Please read the CONTRIBUTING document for further information.

License

KeePassXC code is licensed under GPL-2 or GPL-3. Additional licensing for third-party files is detailed in COPYING.