Go to file
antelle 03cc056558 removed StatsPlugin 2019-01-06 15:38:37 +01:00
.github grammar 2018-03-09 15:23:15 +01:00
app removed file-saver 2019-01-06 15:38:03 +01:00
desktop up electron 2019-01-06 14:45:50 +01:00
graphics remove old gif 2016-07-16 20:59:53 +03:00
helper fix #545: auto-type error on windows 2017-05-06 20:21:20 +02:00
img images 2017-12-03 12:35:37 +01:00
package fix #804: Windows installer upgrade issue 2017-12-11 19:42:26 +01:00
plugins better way to print errors from plugin creation script 2017-12-30 23:30:49 +01:00
util removed an old script 2017-12-26 19:28:56 +01:00
.editorconfig plugins first implementation 2017-02-18 23:46:59 +01:00
.eslintrc upgraded modules, fixed argon2 2019-01-06 11:44:10 +01:00
.gitignore fix after merge 2018-06-21 19:38:06 +02:00
CONTRIBUTING.md docs 2017-11-13 23:09:09 +01:00
DEPS-LICENSE Rename LICENSES-DEPENDENCIES to DEPS-LICENSE 2017-12-04 22:00:27 +01:00
Gruntfile.js up min electron version 2019-01-06 14:46:20 +01:00
LICENSE Update LICENSE 2017-12-04 22:01:46 +01:00
README.md grammar 2018-03-09 15:23:15 +01:00
dev-env.sh dev-env script paths 2017-12-16 12:35:31 +01:00
features.md https url in features 2017-12-16 12:37:51 +01:00
grunt.entrypoints.js moved grunt stuff 2019-01-06 14:32:31 +01:00
grunt.tasks.js moved grunt stuff 2019-01-06 14:32:31 +01:00
package-lock.json removed file-saver 2019-01-06 15:38:03 +01:00
package.json removed file-saver 2019-01-06 15:38:03 +01:00
release-notes.md release notes 2019-01-06 14:39:57 +01:00
webpack.config.js removed StatsPlugin 2019-01-06 15:38:37 +01:00

README.md

Free cross-platform password manager compatible with KeePass

This webapp is a browser and desktop password manager compatible with KeePass databases. It doesn't require any server or additional resources. The app can run either in browser, or as a desktop app.

screenshot

Quick Links

Apps: Web, Desktop
Timeline: Release Notes, TODO
On one page: Features, FAQ
Website: keeweb.info
Twitter: kee_web

Status

The app is already rather stable, so basic stuff should work.
Project roadmap with planned features and approximate schedule is on TODO page.

Self-hosting

Everything you need to host this app on your server is any static file server. The app is a single HTML file + cache manifest (optionally; for offline access). You can download the latest distribution files from gh-pages branch.

If you are using Docker:

  1. put your dh.pem, cert.pem, key.pem to /etc/nginx/external/
  2. run this script:
docker run --name keeweb -d -p 443:443 -p 80:80 -v $EXT_DIR:/etc/nginx/external/ antelle/keeweb

To make Dropbox work in your self-hosted app, go to this Wiki page.

Building

The easiest way to clone all KeeWeb repos is:

curl https://raw.githubusercontent.com/keeweb/keeweb/develop/dev-env.sh | bash -

The app can be built with grunt: grunt (html file will be in dist/).
Desktop apps are built with grunt desktop. This works only in macOS as it builds dmg; requires wine.
Also, a hardware token is required.
To run Electron app without building an installer, build the app with grunt and start it this way:

grunt dev
npm run-script electron

For debug build:

  1. run grunt dev
  2. open http://localhost:8085/tmp

Contributing

Please read contribution guidelines: for issues and for pull requests.
For pull requests: branch is important! master is only for hotfixes, develop is for new features.
Here's a list of issues which need help. Also you can help by translating KeeWeb to your language.

Important notes for pull requests

  • please branch from develop, not master
  • don't edit translation files except base.json, they will be replaced

Donations

KeeWeb is not free to develop. It takes time, requires paid code signing certificates and domains.
You can help the project or say "thank you" with this button:
Donate with PayPal

Please note: donation does not imply any type of service contract.

License

MIT