0
0
mirror of https://github.com/keepassxreboot/keepassxc.git synced 2024-09-19 20:02:18 +02:00
keepassxc/README.md

90 lines
3.1 KiB
Markdown
Raw Normal View History

2016-10-06 05:03:13 +02:00
# KeePassX Reboot
2014-03-23 20:25:15 +01:00
2016-10-06 05:15:58 +02:00
[![Travis Build Status](https://travis-ci.org/keepassxreboot/keepassx.svg?branch=develop)](https://travis-ci.org/keepassxreboot/keepassx) [![Coverage Status](https://coveralls.io/repos/github/keepassxreboot/keepassx/badge.svg?branch=develop)](https://coveralls.io/github/keepassxreboot/keepassx?branch=develop)
2016-10-03 03:30:17 +02:00
## About
2014-03-23 20:25:15 +01:00
Fork of [KeePassX](https://www.keepassx.org/) that [aims to incorporate stalled Pull Requests, features, and bug fixes that are not being incorporated into the main KeePassX baseline](https://github.com/keepassxreboot/keepassx/issues/43).
2014-03-23 20:25:15 +01:00
#### Additional Reboot Features
- keepasshttp support for use with [PassIFox](https://addons.mozilla.org/en-us/firefox/addon/passifox/) for Mozilla Firefox and [chromeIPass](https://chrome.google.com/webstore/detail/chromeipass/ompiailgknfdndiefoaoiligalphfdae) for Google Chrome.
KeePassHttp implementation has been forked from jdachtera's repository, which in turn was based on code from code with Francois Ferrand's [keepassx-http](https://gitorious.org/keepassx/keepassx-http/source/master) repository.
2016-10-06 05:03:13 +02:00
This is a rebuild from [denk-mal's keepasshttp](https://github.com/denk-mal/keepassx.git) that brings it forward to Qt5 and KeePassX v2.x.
2016-02-28 17:00:05 +01:00
#### Build Dependencies
The following tools must exist within your PATH:
* make
2015-07-22 20:53:49 +02:00
* cmake (>= 2.8.12)
* g++ (>= 4.7) or clang++ (>= 3.0)
The following libraries are required:
2015-07-22 20:53:49 +02:00
* Qt 5 (>= 5.2): qtbase and qttools5
* libgcrypt (>= 1.6)
* zlib
* libmicrohttpd
* libxi, libxtst, qtx11extras (optional for auto-type on X11)
2016-10-06 05:03:13 +02:00
On Debian/Ubuntu you can install them with:
```bash
2016-10-12 02:06:28 +02:00
sudo apt-get install build-essential cmake libmicrohttpd-dev libxi-dev libxtst-dev qtbase5-dev libqt5x11extras5-dev qttools5-dev qttools5-dev-tools libgcrypt20-dev zlib1g-dev
```
2016-10-06 05:03:13 +02:00
On Fedora/RHEL/CentOS you can install them with:
```bash
2016-10-12 02:06:28 +02:00
sudo dnf install make automake gcc gcc-c++ cmake libmicrohttpd-devel libXi-devel libXtst-devel qt5-qtbase-devel qt5-qtx11extras qt5-qttools libgcrypt-devel zlib-devel
2016-10-06 05:03:13 +02:00
```
#### Build Steps
To compile from source:
```bash
mkdir build
cd build
2016-02-28 17:00:05 +01:00
cmake -DWITH_TESTS=OFF ..
make [-jX]
```
You will have the compiled KeePassX binary inside the `./build/src/` directory.
To install this binary execute the following:
```bash
sudo make install
```
More detailed instructions available in the INSTALL file.
### Clone Repository
Clone the repository to a suitable location where you can extend and build this project.
```bash
2016-10-12 02:06:28 +02:00
git clone https://github.com/keepassxreboot/keepassx.git
```
**Note:** This will clone the entire contents of the repository at the HEAD revision.
To update the project from within the project's folder you can run the following command:
```bash
git pull
```
### Contributing
2014-11-30 23:23:29 +01:00
We're always looking for suggestions to improve our application. If you have a suggestion for improving an existing feature,
or would like to suggest a completely new feature for KeePassX Reboot, please use the [Issues](https://github.com/keepassxreboot/keepassx/issues) section or our [Google Groups](https://groups.google.com/forum/#!forum/keepassx-reboot) forum.
Please review the [CONTRIBUTING](.github/CONTRIBUTING.md) document for further information.