diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 91 |
1 files changed, 44 insertions, 47 deletions
@@ -1,57 +1,54 @@ -# <img src="https://keepassxc.org/logo.png" width="40" height="40"/> KeePassXC -[/statusIcon)](https://ci.keepassxc.org/?guest=1) [](https://codecov.io/gh/keepassxreboot/keepassxc) - -## About KeePassXC -[KeePassXC](https://keepassxc.org) is a cross-platform community fork of -[KeePassX](https://www.keepassx.org/). -Our goal is to extend and improve it with new features and bugfixes -to provide a feature-rich, fully cross-platform and modern -open-source password manager. - -## Installation -The [KeePassXC QuickStart](./docs/QUICKSTART.md) gets you started using -KeePassXC on your Windows, Mac, or Linux computer using pre-compiled binaries -from the [downloads page](https://keepassxc.org/download). - -Additionally, individual Linux distributions may ship their own versions, -so please check out your distribution's package list to see if KeePassXC is available. - -## Additional features compared to KeePassX -- Auto-Type on all three major platforms (Linux, Windows, macOS) -- Twofish encryption -- YubiKey challenge-response support -- TOTP generation -- CSV import -- A [Command Line Interface (keepassxc-cli)](./share/docs/man/keepassxc-cli.1) -- DEP and ASLR hardening -- Stand-alone password and passphrase generator -- Password strength meter -- Using website favicons as entry icons -- Merging of databases -- Automatic reload when the database changed on disk -- Browser integration with KeePassXC-Browser using [native messaging](https://developer.chrome.com/extensions/nativeMessaging) for [Mozilla Firefox](https://addons.mozilla.org/en-US/firefox/addon/keepassxc-browser/) and [Google Chrome, Chromium, Vivaldi, or Brave](https://chrome.google.com/webstore/detail/keepassxc-browser/oboonakemofpalcgghocfoadofidjkkk) and [Microsoft Edge](https://microsoftedge.microsoft.com/addons/detail/pdffhmdngciaglkoonimfcmckehcpafo) -- Synchronize passwords using KeeShare. See [Using Sharing](./docs/QUICKSTART.md#using-sharing) for more details. -- Many bug fixes - -For a full list of features and changes, read the [CHANGELOG](CHANGELOG.md) document. -For a full list of keyboard shortcuts, see [KEYBINDS](./docs/KEYBINDS.md) +# <img src="https://keepassxc.org/images/keepassxc-logo.svg" width="40" height="40"/> KeePassXC +[/statusIcon)](https://ci.keepassxc.org/?guest=1) +[](https://codecov.io/gh/keepassxreboot/keepassxc) +[](https://github.com/keepassxreboot/keepassxc/releases/) + +[KeePassXC](https://keepassxc.org) 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](https://keepassxc.org/docs/KeePassXC_GettingStarted.html) gets you started using KeePassXC on your Windows, macOS, or Linux computer using pre-compiled binaries from the [downloads page](https://keepassxc.org/download). 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](https://keepassxc.org/docs/KeePassXC_UserGuide.html). + +## 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](CHANGELOG.md) document. \ +For a full list of keyboard shortcuts, see [KeyboardShortcuts.adoc](./docs/topics/KeyboardShortcuts.adoc) ## Building KeePassXC -Detailed instructions are available in the [Build and Install](./INSTALL.md) -page or on the [Wiki page](https://github.com/keepassxreboot/keepassxc/wiki/Building-KeePassXC). +Detailed instructions are available in the [Build and Install](./INSTALL.md) page and in the [Wiki](https://github.com/keepassxreboot/keepassxc/wiki/Building-KeePassXC). ## 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](https://github.com/keepassxreboot/keepassxc/issues) -on GitHub or join us on IRC on freenode channels #keepassxc or #keepassxc-dev. +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](https://github.com/keepassxreboot/keepassxc/issues) on GitHub or join us on IRC in [freenode](https://webchat.freenode.net/) channels #keepassxc and #keepassxc-dev. -You can of course also directly contribute your own code. We are happy to accept your pull requests. - -Please read the [CONTRIBUTING document](.github/CONTRIBUTING.md) for further information. +You may directly contribute your own code by submitting a pull request. Please read the [CONTRIBUTING](.github/CONTRIBUTING.md) document for further information. ## License -GPL-2 or GPL-3 +KeePassXC code is licensed under GPL-2 or GPL-3. Additional licensing for third-party files is detailed in [COPYING](./COPYING). |