Updated: July 29, 2016

Installation

General

  1. Download and unzip the file from the download section.
  2. Copy the KeeAgent.plgx file to the folder where KeePass.exe resides
    • If you used the Windows installer to install KeePass, then the folder will be C:\Program Files (x86)\KeePass Password Safe (64-bit systems) or C:\Program Files\KeePass Password Safe (32-bit systems).
    • On Debian based systems, if you installed the keepass2 package, the folder is /usr/lib/keepass2. However, it is recommended that you install KeeAgent from a package as well (see below).
    • If you use a portable version of KeePass or another OS, and don’t remember where you installed KeePass, you will have to do a search for “KeePass.exe”.

    KeePass searches the Plugins subdirectory of the folder where KeePass.exe resides for plugins. So, for better organization you can create a Plugins subdirectory in the same folder as KeePass.exe and place all of your .plgx files in that folder.
  3. If KeePass is already running, you will need to restart it after you have copied the .plgx file.
  4. When you start KeePass, you should see a dialog that says something like “Compiling Plugins…”. If you get an error message, see the troubleshooting page

Ubuntu / Linux Mint / elementary OS PPA

NOTE: If you did not install KeePass using the keepass2 package, then use the General instructions above.
  1. If you have GNOME Keyring installed, you might want to to disable the SSH component. If you are running the GNOME / Unity / Cinnamon / MATE / Pantheon desktop, GNOME Keyring is installed by default.
  2. Add the PPA to your apt sources:
    $ sudo add-apt-repository ppa:dlech/keepass2-plugins
    $ sudo apt-get update
  3. Install the plugin:
    $ sudo apt-get install keepass2-plugin-keeagent

 

You can get the latest beta version (if there is one) by adding the keepass2-plugins-beta ppa

$ sudo add-apt-repository ppa:dlech/keepass2-plugins-beta
$ sudo apt-get update

You can get the latest version of the keepass2 package from the package maintainers PPA.

$ sudo add-apt-repository ppa:jtaylor/keepass
$ sudo apt-get update
$ sudo apt-get install keepass2
There are several other KeePass plugins that are hosted in the keepass2-plugins PPA. Follow the link to see what is available.

Disable SSH Component of Gnome Keyring

On systems that run the GNOME desktop of one of it’s derivatives, GNOME Keyring is probably installed by default and running even if you don’t know what it is or have never used it before.

Disabling the SSH Agent component of GNOME Keyring is optional, but highly recommended. There is an interesting article on how to do this and why it is a good thing to do even if you don’t use KeeAgent. Be aware that Confirm Constraints will not work with GNOME Keyring’s SSH Agent, so if you choose not to disable it, you will not be able to load keys with a confirm constraint.

It has been reported that disabling this on Fedora 20 will cause KeeAgent not to work.

Here are the essential steps from the article:

  1. Open the gnome-keyring-ssh.desktop file in your favorite text editor (must be root).
    $ gksudo gedit /etc/xdg/autostart/gnome-keyring-ssh.desktop
  2. Change NoDisplay to false, then save and close the file. It should look something like this:
    [Desktop Entry]
    Type=Application
    Name=SSH Key Agent
    Comment=GNOME Keyring: SSH Agent
    Exec=/usr/bin/gnome-keyring-daemon --start --components=ssh
    OnlyShowIn=GNOME;Unity;MATE;
    X-GNOME-Autostart-Phase=Initialization
    X-GNOME-AutoRestart=false
    X-GNOME-Autostart-Notify=true
    X-GNOME-Bugzilla-Bugzilla=GNOME
    X-GNOME-Bugzilla-Product=gnome-keyring
    X-GNOME-Bugzilla-Component=general
    X-GNOME-Bugzilla-Version=3.6.3
    NoDisplay=false
    X-Ubuntu-Gettext-Domain=gnome-keyring
  3. Open Startup Applications in your System Settings and uncheck SSH Key Agent – GNOME Keyring: SSH Agent

    If your System Settings does not have Startup Applications (e.g. GNOME 3.14), copy the /etc/xdg/autostart/gnome-keyring-ssh.desktop file to ~/.config/autostart/gnome-keyring-ssh.desktop and add the line X-GNOME-Autostart-enabled=false to the end. It will have the same effect as making the changes shown in the screenshots.

  4. Log out of your desktop session and log back in