keepassxc/README.md
Janek Bevendorff b0270550c5
Update README
2017-01-25 00:03:00 +01:00

3.8 KiB

KeePassXC - KeePass Cross-platform Community Edition

Travis Build Status Coverage Status

About

KeePassXC is a fork of KeePassX that aims to incorporate stalled pull requests, features, and bug fixes that have never made it into the main KeePassX repository.

Additional features compared to KeePassX

  • Autotype on all three major platforms (Linux, Windows, OS X)
  • Stand-alone password generator
  • Password strength meter
  • Use website's favicons as entry icons
  • Merging of databases
  • Automatic reload when the database changed on disk
  • KeePassHTTP support for use with PassIFox in Mozilla Firefox and chromeIPass in Google Chrome or Chromium.

For a full list of features and changes, read the CHANGELOG document.

Note about KeePassHTTP

KeePassHTTP is not a highly secure protocol and has certain flaw which allow an attacker to decrypt your passwords when they manage to intercept communication between a KeePassHTTP server and PassIFox/chromeIPass over a network connection (see here and here). KeePassXC therefore strictly limits communication between itself and the browser plugin to your local computer. As long as your computer is not compromised, your passwords are fairly safe that way, but still use it at your own risk!

Installation

Pre-compiled binaries can be found on the downloads page. Additionally, individual Linux distributions may ship their own versions, so please check out your distribution's package list to see if KeePassXC is available.

Building KeePassXC yourself

More detailed instructions are available in the INSTALL file or on the Wiki page.

First, you must download the KeePassXC source tarball or check out the latest version from our Git repository.

To clone the project from Git, cd to a suitable location and run

git clone https://github.com/keepassxreboot/keepassxc.git

This will clone the entire contents of the repository and check out the current develop branch.

To update the project from within the project's folder, you can run the following command:

git pull

Once you have downloaded the source code, you can cd into the source code directory and build and install KeePassXC with

mkdir build
cd build
cmake -DWITH_TESTS=OFF ..
make -j8
sudo make install

To enable autotype, add -DWITH_XC_AUTOTYPE=ON to the cmake command. KeePassHTTP support is compiled in by adding -DWITH_XC_HTTP=ON. If these options are not specified, KeePassXC will be built without these plugins.

Contributing

We are always looking for suggestions how to improve our application. If you find any bugs or have an idea for a new feature, please let us know by opening a report in our issue tracker on GitHub or write to our Google Groups forum.

You can of course also directly contribute your own code. We are happy to accept your pull requests.

Please read the CONTRIBUTING document for further information.