Skip to content

Latest commit

 

History

History
 
 

keyhub-vault-web

README.md

Key Vault for Web

This is the web-based offline key vault (a.k.a. "wallet").

Some Browser plugins / extensions have full access over all your personal data when you visit any website or webapp. Recent attacks like Meltdown and Spectre remind us that security is a chain that depends on every layer of a user device (hardware, firmware, operating system, driver, apps, plugins). As all webapps (including this one) depends on the basic safety of your browser, please take precautions by removing all untrustworthy browser plugins.

Running the Local Offline Vault

To run the vault/wallet in offline mode on your computer, follow the instructions below:

Install Caddy HTTP server

Download and install executables from the official caddy website: https://caddyserver.com/download

On MacOS or Ubuntu you may try the installation command below in a terminal:

sudo apt install caddy || sudo yum install caddy || brew install caddy

Build the project

npx lerna bootstrap --scope=keyhub-vault-web

Start the Caddy HTTP server

cd ./keyhub-vault-web
caddy

Note: If "can not download /js/openpgp.worker.js" error appears, perform shift+refresh to ignore the cache

Note: after every change, run

npx lerna bootstrap --scope=keyhub-vault-web

You are now ready to use the offline wallet/vault.

Deployment

  1. Go to project directory
  2. Run this command to run "prepare" script and build the project
npx lerna bootstrap --scope=keyhub-vault-web

/dist folder will appear inside the keyhub-vault-web directory

  1. configure the AWS configure twith the key and secret key
  2. Deploy /dist to S3 by deploying the files to S3, this action will produce /cloudfront/stack.ap-southeast-1.yaml which will be used by cloudfront to point to this specific S3

for sandbox environment

sls deploy

for prod environment

sls deploy --stage=prod
  1. Check whether the files has been uploaded through aws S3 terminal
  2. Check whether index.html can be accessed (no access denied)
  3. Deploy cloudfront by going to /cloudfront then run

for sandbox environment

sls deploy

for prod environment

sls deploy --stage=prod
  1. go to vault.keyhub.app to check the deployment