2015-10-17 23:49:24 +02:00
# KeePass web app (unofficial)
This webapp can read KeePass databases. It doesn't require any server or additional resources.
2015-10-25 09:06:04 +01:00
It can be run either in browser, or as a desktop app.
2015-10-17 23:49:24 +02:00
2015-11-04 07:30:01 +01:00
2015-10-18 00:16:23 +02:00
2015-10-25 09:06:04 +01:00
# Quick Links
2015-10-17 23:49:24 +02:00
2015-10-31 23:01:24 +01:00
Web: [Web App ](https://antelle.github.io/keeweb/ )
2015-11-09 19:41:06 +01:00
Desktop: [Windows ](https://github.com/antelle/keeweb/releases/download/v0.2.0/KeeWeb.win32.exe )
[Mac OSX ](https://github.com/antelle/keeweb/releases/download/v0.2.0/KeeWeb.mac.dmg )
[Linux ](https://github.com/antelle/keeweb/releases/download/v0.2.0/KeeWeb.linux.x64.zip )
2015-10-31 23:20:00 +01:00
Timeline: [Release Notes ](release-notes.md )
[TODO ](TODO.md )
On one page: [Features ](features.md )
2015-10-22 07:38:08 +02:00
2015-10-25 09:06:04 +01:00
# Status
2015-10-22 07:38:08 +02:00
2015-10-25 09:06:04 +01:00
Reading and display is mostly complete; modification and sync is under construction, please see [TODO ](TODO.md ) for more details.
2015-10-25 09:25:48 +01:00
2015-11-08 15:39:09 +01:00
# Known Issues
These major issues are in progress, or will be fixed in next releases, before v1.0:
- auto-update is not implemented
- dropbox sync is one-way: changes are not loaded from dropbox, only saved
2015-11-04 10:49:35 +01:00
# 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 ](https://github.com/antelle/keeweb/tree/gh-pages ) branch.
2015-10-25 09:25:48 +01:00
# Building
2015-10-25 09:27:09 +01:00
The app can be built with grunt: `grunt` (html file will be in `dist/` ) or `grunt watch` (result will be in `tmp/` ).
2015-11-07 08:56:57 +01:00
Electron app is built with `grunt electron` (works only under mac osx as it builds dmg; requires wine).
2015-10-25 09:27:09 +01:00
To run Electron app without building, install electron package (`npm install electron-prebuilt -g`) and start with `electron ./electron/` .
2015-10-25 09:25:48 +01:00
# Contributing
Plugins are not supported for now. If you want to add a feature, please contact the author first. Pull requests, patches and issues are very welcome.
If you have found an bug, please [open an issue ](https://github.com/antelle/keeweb/issues/new ) and fill in the app version and your user-agent
2015-11-04 10:49:35 +01:00
(you can find these details in Settings/Help section).
2015-10-25 09:25:48 +01:00
# License
[MIT ](https://github.com/antelle/keeweb/blob/master/MIT-LICENSE.txt )
