1# KeePassX 2 3## About 4 5KeePassX is an application for people with extremely high demands on secure personal data management. 6It has a light interface, is cross platform and published under the terms of the GNU General Public License. 7 8KeePassX saves many different information e.g. user names, passwords, urls, attachments and comments in one single database. 9For a better management user-defined titles and icons can be specified for each single entry. 10Furthermore the entries are sorted in groups, which are customizable as well. The integrated search function allows to search in a single group or the complete database. 11KeePassX offers a little utility for secure password generation. The password generator is very customizable, fast and easy to use. 12Especially someone who generates passwords frequently will appreciate this feature. 13 14The complete database is always encrypted with the AES (aka Rijndael) encryption algorithm using a 256 bit key. 15Therefore the saved information can be considered as quite safe. KeePassX uses a database format that is compatible with [KeePass Password Safe](http://keepass.info/). 16This makes the use of that application even more favorable. 17 18## Install 19 20KeePassX can be downloaded and installed using an assortment of installers available on the main [KeePassX website](http://www.keepassx.org). 21KeePassX can also be installed from the official repositories of many Linux repositories. 22If you wish to build KeePassX from source, rather than rely on the pre-compiled binaries, you may wish to read up on the _From Source_ section. 23 24### Debian 25 26To install KeePassX from the Debian repository: 27 28```bash 29sudo apt-get install keepassx 30``` 31 32### Red Hat 33 34Install KeePassX from the Red Hat (or CentOS) repository: 35 36```bash 37sudo yum install keepassx 38``` 39 40### Windows / Mac OS X 41 42Download the installer from the KeePassX [download](https://www.keepassx.org/downloads) page. 43Once downloaded, double click on the file to execute the installer. 44 45### From Source 46 47#### Build Dependencies 48 49The following tools must exist within your PATH: 50 51* make 52* cmake (>= 2.8.12) 53* g++ (>= 4.7) or clang++ (>= 3.0) 54 55The following libraries are required: 56 57* Qt 5 (>= 5.2): qtbase and qttools5 58* libgcrypt (>= 1.6) 59* zlib 60* libxi, libxtst, qtx11extras (optional for auto-type on X11) 61 62On Debian you can install them with: 63 64```bash 65sudo apt-get install build-essential cmake qtbase5-dev libqt5x11extras5-dev qttools5-dev qttools5-dev-tools libgcrypt20-dev zlib1g-dev libxi-dev libxtst-dev 66``` 67 68#### Build Steps 69 70To compile from source: 71 72```bash 73mkdir build 74cd build 75cmake .. 76make [-jX] 77``` 78 79You will have the compiled KeePassX binary inside the `./build/src/` directory. 80 81To install this binary execute the following: 82 83```bash 84sudo make install 85``` 86 87More detailed instructions available in the INSTALL file. 88 89## Contribute 90 91Coordination of work between developers is handled through the [KeePassX development](https://www.keepassx.org/dev/) site. 92Requests for enhancements, or reports of bugs encountered, can also be reported through the KeePassX development site. 93However, members of the open-source community are encouraged to submit pull requests directly through GitHub. 94 95### Clone Repository 96 97Clone the repository to a suitable location where you can extend and build this project. 98 99```bash 100git clone https://github.com/keepassx/keepassx.git 101``` 102 103**Note:** This will clone the entire contents of the repository at the HEAD revision. 104 105To update the project from within the project's folder you can run the following command: 106 107```bash 108git pull 109``` 110 111### Feature Requests 112 113We're always looking for suggestions to improve our application. If you have a suggestion for improving an existing feature, 114or would like to suggest a completely new feature for KeePassX, please file a ticket on the [KeePassX development](https://www.keepassx.org/dev/) site. 115 116### Bug Reports 117 118Our software isn't always perfect, but we strive to always improve our work. You may file bug reports on the [KeePassX development](https://www.keepassx.org/dev/) site. 119 120### Pull Requests 121 122Along with our desire to hear your feedback and suggestions, we're also interested in accepting direct assistance in the form of code. 123 124Issue merge requests against our [GitHub repository](https://github.com/keepassx/keepassx). 125 126### Translations 127 128Translations are managed on [Transifex](https://www.transifex.com/projects/p/keepassx/) which offers a web interface. 129Please join an existing language team or request a new one if there is none. 130