Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 4.23 KB

README.md

File metadata and controls

68 lines (49 loc) · 4.23 KB
Raw

Simple and secure password management

Kee adds free, secure and easy to use password management features to your web browser which save you time and keep your private data more secure.

Login automatically, never forget another password, stay in control of your passwords and improve their security. Powered by the world-renowned KeePass Password Safe.

Kee is a Firefox and Chrome add-on for linking browsers to KeePass, using the KeePassRPC KeePass plugin.

Official website with download instructions: https://www.kee.pm

Support forum: https://forum.kee.pm

Build

Requirements

  • node
  • npm or yarn
  • a web browser and KeePass 2.x

It's all set up for Visual Studio Code but it shouldn't be too hard to work out how to develop using other IDEs.

Instructions

  1. clone the repo
  2. npm install
  3. Development:
    1. npm start
    2. then load the relevant folder into your development browser
      1. Chrome:
        1. chrome://extensions/
        2. Load unpacked extension...
        3. 'build/debug/chrome/'
      2. Firefox:
        1. about:debugging#addons
        2. Load temporary add-on
        3. 'build/debug/firefox/'
    3. Make your changes to the source code; the file watcher will recompile necessary parts of the addon
    4. When you're ready to test your changes, reload the extension/addon from the browser interface (this is only necessary sometimes; a lot of changes will apply automatically but it may not be obvious when a reload operation is required so play it safe until you understand the add-on architecture)
    5. NB: source maps are included only in the debug folders
  4. Packaging for distribution
    1. Historically this has been done manually but we think that TravisCI should now handle this for us
    2. Manipulate manifest.json as required
    3. npm run package:debug and/or npm run package:prod
    4. XPIs and ZIPs of each version are put into the dist folder
    5. NB: source maps are included only in the debug package

gulp comes with various other tasks but you shouldn't need to worry about those unless you are adding new modules/folders to the addon.

Reproducing a build

Exactly reproducing the files delivered from the Firefox add-on website or Chrome extension store is not possible because the websites modify the file that we build in order to attach a digital signature. One can get very close though, to the point where a diff of the files from a given release on GitHub varies from your own local build in only three ways:

  1. Line endings - some parts of the tool chain may treat line endings differently so that the end result could differ between operating systems.
  2. Version number - the CI build system holds credentials that allow it to manipulate git tags on the GitHub repository and in doing so allows for automatic incrementing of build numbers, which in turn will result in a unique version number being calculated. This can only be reproduced if you download the git repo to your local system (including all tags) and develop a custom build script or modify the source files as needed - it's most likely not worth the effort but can be done if it is important to you.
  3. File dates - the build output is essentially a zip file so when the newly dowloaded and built files on your system are added to the zip file, they will have different dates than those that were built on the CI platform and automatically added to a GitHub Release. For this reason, even if you were to end up with the same line endings and version number, it is not possible to compare a digest (hash) of your built file and expect it to match the file built by anyone else (unless you build it at exactly the same time!)

Reproducible builds rely upon npm version 5.7 or higher (released end of Feb 2018) so ensure you have the latest update first.

You can then:

  1. download the source code (e.g. from the relevant GitHub Release page) or clone the repo for the latest (often pre-release) version
  2. npm ci
  3. manipulate manifest.json if you want to adjust version numbers
  4. npm run package:debug (for beta releases) and/or npm run package:prod (for stable releases)
    1. XPIs and ZIPs of each version are put into the dist folder
    2. NB: source maps are included only in the debug package