Go to file
Aetherinox 03540d66c6
chore: lint
2024-04-26 13:42:15 -07:00
.github refactor: misc minor edits 2024-04-25 19:31:56 -07:00
app chore: lint 2024-04-26 13:42:15 -07:00
assets/fonts src: add assets 2024-04-22 16:19:58 -07:00
build misc: minor edits to prep for markdown feature 2024-04-25 20:17:58 -07:00
desktop fix: return used outside method 2024-04-21 21:50:25 -07:00
graphics fix #689: custom title bar on Windows 2021-03-03 22:12:49 +01:00
img updated screenshot 2020-11-29 14:44:39 +01:00
package creating browser socket in a group container on macOS 2021-04-15 20:38:13 +02:00
plugins deps: update scss to support newest css loaders, add sass:math module 2024-04-21 04:31:53 -07:00
test tests: update mdToHtml with two additional arguments 2024-04-25 19:44:26 -07:00
util always write version with 2 spaces 2021-05-08 19:35:36 +02:00
.all-contributorsrc docs: add all-contributors 2024-04-22 07:23:08 -07:00
.babelrc deps: update babel plugins 2024-04-21 04:41:48 -07:00
.editorconfig misc: housekeeping 2024-04-21 04:47:05 -07:00
.eslintrc chore: modify linter 2024-04-21 21:49:32 -07:00
.gitattributes misc: housekeeping 2024-04-21 04:47:05 -07:00
.gitignore docs: add all-contributors 2024-04-22 07:23:08 -07:00
.npmrc chore: add & sync package-lock 2024-04-21 09:17:59 -07:00
.nvmrc misc: housekeeping 2024-04-21 04:47:05 -07:00
.prettierrc Fix build config to support Windows path separators and newlines 2020-01-18 16:42:36 +13:00
CONTRIBUTING.md docs: update readme, contributing guide 2024-04-22 07:21:10 -07:00
DEPS-LICENSE Rename LICENSES-DEPENDENCIES to DEPS-LICENSE 2017-12-04 22:00:27 +01:00
Gruntfile.js chore: clean up comments 2024-04-21 21:50:05 -07:00
LICENSE year 2021-01-30 23:41:32 +01:00
README.md style: minor file changes 2024-04-22 09:52:27 -07:00
SECURITY.md Create SECURITY.md 2020-04-28 23:33:23 +02:00
babel.config.js deps: add babel env config 2024-04-21 04:43:23 -07:00
dev-env.sh renamed the extension 2021-04-17 16:57:06 +02:00
grunt.entrypoints.js deleted native-messaging-host 2021-04-20 17:07:50 +02:00
grunt.tasks.js fixed Windows code signing 2021-05-08 19:57:02 +02:00
jsconfig.json jsconfig for vscode 2019-09-16 18:34:58 +02:00
keeweb.js build: add pre-build script 2024-04-22 07:22:22 -07:00
package-lock.json feat: add markdown update 2024-04-26 13:33:09 -07:00
package.json feat: add markdown update 2024-04-26 13:33:09 -07:00
postcss.config.js autoprefixer 2019-09-20 23:37:17 +02:00
release-notes.md release notes 2021-07-18 16:20:52 +02:00
webpack.config.js deps: update webpack to v5.91.0, webpack-dev-server to v5.0.4 (#2163, #2156) 2024-04-21 04:24:30 -07:00

README.md

KeeWeb Password Manager🔑


KeeWeb is a browser and desktop password manager which is capable of opening up existing KeePass database `kdbx` files, or creating new vaults to store your important credentials in.

screenshot


Test Status Code Coverage Last Commit Size All Contributors






About

KeeWeb is a password manager which supports managing kdbx files created by other applications such as KeePass, KeePassXC, etc. You choose the platform you wish to run; as KeeWeb supports being installed and ran as either a Desktop application, or in your web-browser.


With support for Linux, Windows, and MacOS, we give you the tools to seamlessly manage your most important credentials across multiple applications and platforms.


Decide how you want to save your credential vault, KeeWeb supports saving your database as a local file, or you can store your password vault with some of the most popular cloud services such as Dropbox, Google Drive, and Microsoft OneDrive.


Review some of our most important links below to learn more about KeeWeb and who we are:


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




Self-hosting

Want to self-host your copy of KeeWeb? Everything you need to host this app on your server is provided within the package. KeeWeb itself is a single HTML file combined with a service worker (optionally; for offline access).


You can download the latest distribution files from gh-pages branch.


Docker Users:

  1. Place your dh.pem, cert.pem, key.pem to /etc/nginx/external/
  2. Then execute the command below:

docker run --name keeweb -d -p 443:443 -p 80:80 -v $EXT_DIR:/etc/nginx/external/ antelle/keeweb

To configure Dropbox support on your self-hosted setup view our Wiki page.




Build From Source

The easiest way to clone all KeeWeb repos is:

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

KeeWeb can be built utilizing the grunt commandline. Each platform has multiple commands you can use; pick one:


Platform: Windows

You may build KeeWeb for Windows by executing ONE of the following two commands provided:

Using Grunt

grunt dev-desktop-win32 --skip-sign

Using NPM

npm run dev-desktop-windows

Platform: Linux

You may build KeeWeb for Linux by executing ONE of the following two commands provided:

Using Grunt

grunt dev-desktop-linux --skip-sign

Using NPM

npm run dev-desktop-linux

Platform: MacOS

You may build KeeWeb for MacOS by executing ONE of the following two commands provided:

Using Grunt

grunt dev-desktop-darwin --skip-sign

Using NPM

npm run dev-desktop-macos

Once the build is complete, all (html files will be in dist/ folder. To build KeeWeb, utilize the following commands below.


To run the desktop (electron) app without building an installer, build the app with grunt and then launch KeeWeb with one of the following commands:


npm run dev
npm run electron

To debug your build:

  1. run npm run dev
  2. open http://localhost:8085

Once built, the output files will be generated in tmp:




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:
OpenCollective


You can also sponsor the developer directly on GitHub.


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




Contributors

We are always looking for contributors. If you feel that you can provide something useful to KeeWeb, then we'd love to review your suggestion. Before submitting your contribution, please review the following resources:


Want to help but can't write code?


The following people have helped get this project going:

All Contributors

Antelle
Antelle

💻 📆 🔍
Aetherinox
Aetherinox

💻 📆 🔍
HarlemSquirrel
HarlemSquirrel

💻 📆