0.29.0 • Published 9 years ago

grunt-atom-shell-installer v0.29.0

Weekly downloads
2
License
MIT
Repository
github
Last release
9 years ago

Atom Shell Installer Grunt Plugin

Build status

Grunt plugin that builds Windows installers for Atom Shell apps using Squirrel.

Installing

npm install --save-dev grunt-atom-shell-installer

Configuring

In your Gruntfile.coffee or Gruntfile.js add the following:

grunt.loadNpmTasks('grunt-atom-shell-installer')

Then assuming you have an Atom Shell app built at the given appDirectory, you can configure the installer task like so:

'create-windows-installer': {
  appDirectory: '/tmp/build/my-app',
  outputDirectory: '/tmp/build/installer',
  authors: 'My App Inc.',
  exe: 'myapp.exe'
}

Then run grunt create-windows-installer and you will have an .nupkg, a RELEASES file, and a .exe installer file in the outputDirectory folder.

There are several configuration settings supported:

Config NameRequiredDescription
appDirectoryYesThe folder path of your Atom Shell-based app
outputDirectoryNoThe folder path to create the .exe installer in. Defaults to the installer folder at the project root.
loadingGifNoThe local path to a .gif file to display during install.
authorsYesThe authors value for the nuget package metadata. Defaults to the author field from your app's package.json file when unspecified.
ownersNoThe owners value for the nuget package metadata. Defaults to the authors field when unspecified.
exeNoThe name of your app's main .exe file. This uses the name field in your app's package.json file with an added .exe extension when unspecified.
descriptionNoThe description value for the nuget package metadata. Defaults to the description field from your app's package.json file when unspecified.
versionNoThe version value for the nuget package metadata. Defaults to the version field from your app's package.json file when unspecified.
titleNoThe title value for the nuget package metadata. Defaults to the productName field and then the name field from your app's package.json file when unspecified.
certificateFileNoThe path to an Authenticode Code Signing Certificate
certificatePasswordNoThe password to decrypt the certificate given in certificateFile
signWithParamsNoParams to pass to signtool. Overrides certificateFile and certificatePassword.
setupIconNoThe ICO file to use as the icon for the generated Setup.exe
remoteReleasesNoA URL to your existing updates. If given, these will be downloaded to create delta updates

Sign your installer or else bad things will happen

For development / internal use, creating installers without a signature is okay, but for a production app you need to sign your application. Internet Explorer's SmartScreen filter will block your app from being downloaded, and many anti-virus vendors will consider your app as malware unless you obtain a valid cert.

Any certificate valid for "Authenticode Code Signing" will work here, but if you get the right kind of code certificate, you can also opt-in to Windows Error Reporting. This MSDN page has the latest links on where to get a WER-compatible certificate. The "Standard Code Signing" certificate is sufficient for this purpose.

0.29.0

9 years ago

0.28.0

9 years ago

0.27.0

9 years ago

0.26.0

9 years ago

0.25.0

9 years ago

0.24.0

9 years ago

0.23.0

9 years ago

0.22.0

9 years ago

0.21.0

9 years ago

0.20.0

9 years ago

0.19.0

9 years ago

0.18.0

9 years ago

0.17.0

9 years ago

0.13.2

9 years ago

0.16.0

9 years ago

0.13.1

9 years ago

0.15.0

9 years ago

0.14.0

9 years ago

0.13.0

9 years ago

0.12.0

9 years ago

0.11.0

9 years ago

0.10.0

9 years ago

0.9.0

9 years ago

0.8.0

9 years ago

0.7.0

9 years ago

0.6.0

9 years ago

0.5.0

9 years ago

0.4.0

9 years ago

0.3.0

9 years ago

0.2.0

9 years ago

0.1.0

9 years ago