Skip to content
This repository has been archived by the owner on Apr 29, 2021. It is now read-only.

Latest commit

 

History

History
77 lines (54 loc) · 2.59 KB

BUILDS.md

File metadata and controls

77 lines (54 loc) · 2.59 KB
Raw

Creating Builds

You can create builds for all platforms by running:

yarn build

Note: This will not work on Windows machines, you will need to manually delete the dist/ directory and run:

yarn build:windows

The build process copies assets from the public/ directory into build/ via react-scripts, electron-builder picks up assets from the build/ directory to bundle into native applications.

Signing Builds (Mac)

  1. Register as an Apple developer
  2. Purchase a code-signing certificate and download the PFX bundle
  3. Install your code signing certificate to the Mac certificate store
  4. Sign the app by running:
yarn build:mac

Signing Builds (Windows)

  1. Obtain a Microsoft Authenticode code-signing certificate (we use digicert)
  2. Export the private and public key as a p12 file
  3. Use openssl to convert p12 to pvk and spc files
openssl pkcs12 -in $P12_FILE -nocerts -nodes -out temp-rsa.pem
openssl rsa -in temp-rsa.pem -outform PVK -pvk-strong -out windows-code-cert.pvk

openssl pkcs12 -in $P12_FILE -nokeys -nodes -out temp-cert.pem
openssl crl2pkcs7 -nocrl -certfile temp-cert.pem -outform DER -out windows-code-cert.spc
  1. If you are on Mac - install mono, if you don't have it already
brew install mono
  1. Build the windows executable and sign
yarn build:windows
signcode -$ commercial -a sha1 -t http://timestamp.digicert.com -i $MAIN_URL -spc $SPC_FILE.spc -v $PVK_FILE.pvk -n \"Stethoscope Installer\" \"dist/Stethoscope Setup $npm_package_version.exe\"

Supporting Automatic Updates

NOTE: You will need to codesign Mac and Windows builds for automatic updates to work on either platform

There are quite a few options in the electron-builder docs for automatic updates and we suggest you pick one that is best suited for your organization - autotmatic update documentation.

We use S3 internally as a generic file server and manually deploy the assets (though electron-builder can be configured to push builds to S3), the setup process is essentially:

  1. Create a public S3 bucket
  2. Ensure that build.publish is pointed to your S3 bucket in package.json
"publish": [
  {
    "provider": "generic",
    "url": "https://s3-us-west-2.amazonaws.com/your-public-s3-bucket/"
  }
]
  1. Build and sign app(s)
  2. Upload signed build artifacts (dist/*.{dmg,exe,blockmap,yml}) to S3

Once that is in place, the app's "Check for updates" link in the menu will download new versions and prompt the user to restart.