Notices: This section not yet converted to new layout. Download stats are rolling back out.

Chocolatey MSI Template

1.0.1

Package test results are passing.

This package was approved by moderator AdmiringWorm on 6/18/2017.

Chocolatey MSI Template

This adds a template for MSI packages.

To install Chocolatey MSI Template, run the following command from the command line or from PowerShell:

C:\> choco install msi.template

To upgrade Chocolatey MSI Template, run the following command from the command line or from PowerShell:

C:\> choco upgrade msi.template

Files

Hide
  • templates\msi.nuspec.template Show
    <?xml version="1.0" encoding="utf-8"?>
    <!-- Read this before creating packages: https://chocolatey.org/docs/create-packages -->
    <!-- Test your packages in a test environment: https://github.com/chocolatey/chocolatey-test-environment -->
    <!-- Do not remove this test for UTF-8: if “Ω” doesn’t appear as greek uppercase omega letter enclosed in quotation marks, you should use an editor that supports UTF-8, not this one. -->
    <package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
      <metadata>
        <!-- == PACKAGE SPECIFIC SECTION == -->
        <!-- This section is about this package, although id and version have ties back to the software -->
        <!-- id is lowercase and if you want a good separator for words, use '-', not '.'. Dots are only acceptable as suffixes for certain types of packages, e.g. .install, .portable, .extension, .template -->
        <!-- If the software is cross-platform, attempt to use the same id as the debian/rpm package(s) if possible. -->
        <id>[[PackageNameLower]]</id>
        <!-- version should MATCH as closely as possible with the underlying software -->
        <!-- Is the version a prerelease of a version? https://docs.nuget.org/create/versioning#creating-prerelease-packages -->
        <!-- Note that unstable versions like 0.0.1 can be considered a released version, but it's possible that one can release a 0.0.1-beta before you release a 0.0.1 version. If the version number is final, that is considered a released version and not a prerelease. -->
        <version>[[PackageVersion]]</version>
        <!--PackageSourceUrl - Where is this Chocolatey package located (think GitHub)? packageSourceUrl is highly recommended for the community feed-->
        <packageSourceUrl>http://github.com/[[MaintainerRepo]]/[[PackageNameLower]]</packageSourceUrl>
        <!-- owners is a poor name for maintainers of the package. It sticks around by this name for compatibility reasons. It basically means you. -->
        <owners>[[MaintainerName]]</owners>
        <!-- ============================== -->
    
        <!-- == SOFTWARE SPECIFIC SECTION == -->
        <!-- This section is about the software itself -->
        <title>[[PackageName]] (Install)</title>
        <authors>__REPLACE_AUTHORS_OF_SOFTWARE_COMMA_SEPARATED__</authors>
        <!-- projectUrl is required for the community feed -->
        <projectUrl>https://_Software_Location_REMOVE_OR_FILL_OUT_</projectUrl>
        <!--<iconUrl>http://cdn.rawgit.com/[[MaintainerRepo]]/master/icons/[[PackageNameLower]].png</iconUrl>-->
        <!-- <copyright>Year Software Vendor</copyright> -->
        <!-- If there is a license Url available, it is is required for the community feed -->
        <!-- <licenseUrl>Software License Location __REMOVE_OR_FILL_OUT__</licenseUrl>
        <requireLicenseAcceptance>true</requireLicenseAcceptance>-->
        <!--<projectSourceUrl>Software Source Location - is the software FOSS somewhere? Link to it with this</projectSourceUrl>-->
        <!--<docsUrl>At what url are the software docs located?</docsUrl>-->
        <!--<mailingListUrl></mailingListUrl>-->
        <!--<bugTrackerUrl></bugTrackerUrl>-->
        <tags>[[PackageNameLower]] admin SPACE_SEPARATED</tags>
        <summary>__REPLACE__</summary>
        <description>__REPLACE__MarkDown_Okay [[AutomaticPackageNotesNuspec]]</description>
        <!-- <releaseNotes>__REPLACE_OR_REMOVE__MarkDown_Okay</releaseNotes> -->
        <!-- =============================== -->      
    
        <!-- Specifying dependencies and version ranges? https://docs.nuget.org/create/versioning#specifying-version-ranges-in-.nuspec-files -->
        <!--<dependencies>
          <dependency id="" version="__MINIMUM_VERSION__" />
          <dependency id="" version="[__EXACT_VERSION__]" />
          <dependency id="" version="[_MIN_VERSION_INCLUSIVE, MAX_VERSION_INCLUSIVE]" />
          <dependency id="" version="[_MIN_VERSION_INCLUSIVE, MAX_VERSION_EXCLUSIVE)" />
          <dependency id="" />
          <dependency id="chocolatey-uninstall.extension" />
        </dependencies>-->
        <!-- chocolatey-uninstall.extension - If supporting 0.9.9.x (or below) and including a chocolateyUninstall.ps1 file to uninstall an EXE/MSI, you probably want to include chocolatey-uninstall.extension as a dependency. Please verify whether you are using a helper function from that package. -->
    
        <!--<provides>NOT YET IMPLEMENTED</provides>-->
        <!--<conflicts>NOT YET IMPLEMENTED</conflicts>-->
        <!--<replaces>NOT YET IMPLEMENTED</replaces>-->
      </metadata>
      <files>
        <!-- this section controls what actually gets packaged into the Chocolatey package -->
        <file src="tools\**" target="tools" />
        <!--Building from Linux? You may need this instead: <file src="tools/**" target="tools" />-->
      </files>
    </package>
    
  • templates\ReadMe.md Show
    ## Summary
    How do I create packages? See https://chocolatey.org/docs/create-packages
    
    If you are submitting packages to the community feed (https://chocolatey.org)
    always try to ensure you have read, understood and adhere to the create
    packages wiki link above.
    
    ## Automatic Packaging Updates?
    Consider making this package an automatic package, for the best 
    maintainability over time. Read up at https://chocolatey.org/docs/automatic-packages
    
    ## Shim Generation
    Any executables you include in the package or download (but don't call 
    install against using the built-in functions) will be automatically shimmed.
    
    This means those executables will automatically be included on the path.
    Shim generation runs whether the package is self-contained or uses automation 
    scripts. 
    
    By default, these are considered console applications.
    
    If the application is a GUI, you should create an empty file next to the exe 
    named 'name.exe.gui' e.g. 'bob.exe' would need a file named 'bob.exe.gui'.
    See https://chocolatey.org/docs/create-packages#how-do-i-set-up-shims-for-applications-that-have-a-gui
    
    If you want to ignore the executable, create an empty file next to the exe 
    named 'name.exe.ignore' e.g. 'bob.exe' would need a file named 
    'bob.exe.ignore'. 
    See https://chocolatey.org/docs/create-packages#how-do-i-exclude-executables-from-getting-shims
    
    ## Self-Contained? 
    If you have a self-contained package, you can remove the automation scripts 
    entirely and just include the executables, they will automatically get shimmed, 
    which puts them on the path. Ensure you have the legal right to distribute 
    the application though. See https://chocolatey.org/docs/legal. 
    
    You should read up on the Shim Generation section to familiarize yourself 
    on what to do with GUI applications and/or ignoring shims.
    
    ## Automation Scripts
    You have a powerful use of Chocolatey, as you are using PowerShell. So you
    can do just about anything you need. Choco has some very handy built-in 
    functions that you can use, these are sometimes called the helpers.
    
    ### Built-In Functions
    https://chocolatey.org/docs/helpers-reference
    
    A note about a couple:
    * Get-BinRoot - this is a horribly named function that doesn't do what new folks think it does. It gets you the 'tools' root, which by default is set to 'c:\tools', not the chocolateyInstall bin folder - see https://chocolatey.org/docs/helpers-get-tools-location
    * Install-BinFile - used for non-exe files - executables are automatically shimmed... - see https://chocolatey.org/docs/helpers-install-bin-file
    * Uninstall-BinFile - used for non-exe files - executables are automatically shimmed - see https://chocolatey.org/docs/helpers-uninstall-bin-file
    
    ### Getting package specific information
    Use the package parameters pattern - see https://chocolatey.org/docs/how-to-parse-package-parameters-argument
    
    ### Need to mount an ISO?
    https://chocolatey.org/docs/how-to-mount-an-iso-in-chocolatey-package
    
    
    ### Environment Variables
    Chocolatey makes a number of environment variables available (You can access any of these with $env:TheVariableNameBelow):
    
     * TEMP = Overridden to the CacheLocation, but may be the same as the original TEMP folder
     * ChocolateyInstall = Top level folder where Chocolatey is installed
     * chocolateyPackageName = The name of the package, equivalent to the id in the nuspec (0.9.9+)
     * chocolateyPackageVersion = The version of the package, equivalent to the version in the nuspec (0.9.9+)
     * chocolateyPackageFolder = The top level location of the package folder
    
    #### Advanced Environment Variables
    The following are more advanced settings:
    
     * chocolateyPackageParameters = (0.9.8.22+)
     * CHOCOLATEY_VERSION = The version of Choco you normally see. Use if you are 'lighting' things up based on choco version. (0.9.9+)
        - Otherwise take a dependency on the specific version you need. 
     * chocolateyForceX86 = If available and set to 'true', then user has requested 32bit version. (0.9.9+)
        - Automatically handled in built in Choco functions. 
     * OS_PLATFORM = Like Windows, OSX, Linux. (0.9.9+)
     * OS_VERSION = The version of OS, like 6.1 something something for Windows. (0.9.9+)
     * OS_NAME = The reported name of the OS. (0.9.9+)
     * IS_PROCESSELEVATED = Is the process elevated? (0.9.9+)
     
    #### Experimental Environment Variables
    The following are experimental or use not recommended:
    
     * OS_IS64BIT = This may not return correctly - it may depend on the process the app is running under (0.9.9+)
     * CHOCOLATEY_VERSION_PRODUCT = the version of Choco that may match CHOCOLATEY_VERSION but may be different (0.9.9+)
        - it's based on git describe
     * IS_ADMIN = Is the user an administrator? But doesn't tell you if the process is elevated. (0.9.9+)
     * chocolateyInstallOverride = Not for use in package automation scripts. (0.9.9+)
     * chocolateyInstallArguments = the installer arguments meant for the native installer. You should use chocolateyPackageParameters intead. (0.9.9+)
    
    
  • templates\tools\chocolateybeforemodify.ps1 Show
    # This runs in 0.9.10+ before upgrade and uninstall.
    # Use this file to do things like stop services prior to upgrade or uninstall.
    # NOTE: It is an anti-pattern to call chocolateyUninstall.ps1 from here. If you
    #  need to uninstall an MSI prior to upgrade, put the functionality in this
    #  file without calling the uninstall script. Make it idempotent in the
    #  uninstall script so that it doesn't fail when it is already uninstalled.
    # NOTE: For upgrades - like the uninstall script, this script always runs from 
    #  the currently installed version, not from the new upgraded package version.
    
    
  • templates\tools\chocolateyinstall.ps1 Show
    $ErrorActionPreference = 'Stop';
    
    [[AutomaticPackageNotesInstaller]]
    $packageName= '[[PackageName]]'
    $toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
    #$fileLocation = Join-Path $toolsDir 'NAME_OF_EMBEDDED_INSTALLER_FILE'
    
    $packageArgs = @{
      packageName   = $packageName
      unzipLocation = $toolsDir
      fileType      = 'MSI'
      url           = '[[Url]]' # download url, HTTPS preferred
      url64bit      = '[[Url64]]' # 64bit URL here (HTTPS preferred) or remove - if installer contains both (very rare), use $url
      #file         = $fileLocation
    
      softwareName  = '[[PackageName]]*' #part or all of the Display Name as you see it in Programs and Features. It should be enough to be unique
    
      checksum      = '[[Checksum]]'
      checksumType  = 'sha256' #default is md5, can also be sha1, sha256 or sha512
      checksum64    = '[[Checksum64]]'
      checksumType64= 'sha256'
    
      silentArgs    = "[[SilentArgs]]" # ALLUSERS=1 DISABLEDESKTOPSHORTCUT=1 ADDDESKTOPICON=0 ADDSTARTMENU=0
      validExitCodes= @(0, 3010, 1641)
    }
    
    #https://chocolatey.org/docs/helpers-install-chocolatey-package
    Install-ChocolateyPackage @packageArgs
    ## If you are making your own internal packages (organizations), you can embed the installer or
    ## put on internal file share and use the following instead (you'll need to add $file to the above)
    # https://chocolatey.org/docs/helpers-install-chocolatey-install-package
    #Install-ChocolateyInstallPackage @packageArgs
    
  • templates\tools\chocolateyuninstall.ps1 Show
    $ErrorActionPreference = 'Stop'; # stop on all errors
    
    $packageName = '[[PackageName]]'
    $softwareName = '[[PackageName]]*' #part or all of the Display Name as you see it in Programs and Features. It should be enough to be unique
    $installerType = 'MSI' 
    $silentArgs = '/qn /norestart'
    # https://msdn.microsoft.com/en-us/library/aa376931(v=vs.85).aspx
    $validExitCodes = @(0, 3010, 1605, 1614, 1641)
    
    $uninstalled = $false
    # Get-UninstallRegistryKey is new to 0.9.10, if supporting 0.9.9.x and below,
    # take a dependency on "chocolatey-uninstall.extension" in your nuspec file.
    # This is only a fuzzy search if $softwareName includes '*'. Otherwise it is 
    # exact. In the case of versions in key names, we recommend removing the version
    # and using '*'.
    [array]$key = Get-UninstallRegistryKey -SoftwareName $softwareName
    
    if ($key.Count -eq 1) {
      $key | % { 
        $file = "$($_.UninstallString)"
    
        if ($installerType -eq 'MSI') {
          # The Product Code GUID is all that should be passed for MSI, and very 
          # FIRST, because it comes directly after /x, which is already set in the 
          # Uninstall-ChocolateyPackage msiargs (facepalm).
          $silentArgs = "$($_.PSChildName) $silentArgs"
    
          # Don't pass anything for file, it is ignored for msi (facepalm number 2) 
          # Alternatively if you need to pass a path to an msi, determine that and 
          # use it instead of the above in silentArgs, still very first
          $file = ''
        }
    
        Uninstall-ChocolateyPackage -PackageName $packageName `
                                    -FileType $installerType `
                                    -SilentArgs "$silentArgs" `
                                    -ValidExitCodes $validExitCodes `
                                    -File "$file"
      }
    } elseif ($key.Count -eq 0) {
      Write-Warning "$packageName has already been uninstalled by other means."
    } elseif ($key.Count -gt 1) {
      Write-Warning "$key.Count matches found!"
      Write-Warning "To prevent accidental data loss, no programs will be uninstalled."
      Write-Warning "Please alert package maintainer the following keys were matched:"
      $key | % {Write-Warning "- $_.DisplayName"}
    }
  • templates\tools\LICENSE.txt Show
    Note: Include this file if including binaries you have the right to distribute. 
    Otherwise delete. this file.
    
    ===DELETE ABOVE THIS LINE AND THIS LINE===
    
    From: <insert applicable license url here>
    
    LICENSE
    
    <Insert License Here>
    
  • templates\tools\VERIFICATION.txt Show
    Note: Include this file if including binaries you have the right to distribute. 
    Otherwise delete. this file.
    
    ===DELETE ABOVE THIS LINE AND THIS LINE===
    
    VERIFICATION
    Verification is intended to assist the Chocolatey moderators and community
    in verifying that this package's contents are trustworthy.
     
    <Include details of how to verify checksum contents>

Virus Scan Results

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Dependencies

This package has no dependencies.

Package Maintainer(s)

Software Author(s)

  • Rob Reynolds
  • The Chocolatey Team

Copyright

RealDimensions Software, LLC - 2016-Present

Tags

Release Notes

1.0.1

Ensure fileType is MSI

1.0.0

Initial

Version History

Version Downloads Last updated Status
Chocolatey MSI Template 1.0.0 291 Thursday, August 18, 2016 approved

Discussion for the Chocolatey MSI Template Package

Ground rules:

  • This discussion is only about Chocolatey MSI Template and the Chocolatey MSI Template package. If you have feedback for Chocolatey, please contact the google group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Chocolatey MSI Template, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.

comments powered by Disqus
Chocolatey.org uses cookies to enhance the user experience of the site.
Ok