The dmg cookbook has been deprecated

Author provided reason for deprecation:

The dmg cookbook has been deprecated and is no longer being maintained by its authors. Use of the dmg cookbook is no longer recommended.

RSS

dmg (25) Versions 4.1.1 Follow34

Resource for installing macOS applications from DMGs

Policyfile

Berkshelf

Knife

cookbook 'dmg', '~> 4.1.1', :supermarket

cookbook 'dmg', '~> 4.1.1'

knife supermarket install dmg

knife supermarket download dmg

README

Dependencies

Changelog

Quality 17%

The dmg_package resource is now included in Chef 14 and this cookbook has been deprecated. We highly recommend updating to Chef 14 so you can use this resource without the need for a cookbook dependency.

dmg Cookbook

Resource to install OS X applications (.app) from dmg files.

Requirements

Platforms

macOS

Chef

Chef 12.5+

Cookbooks

none

Resources/Providers

dmg_package

This resource will install a DMG "Package". It will retrieve the DMG from a remote URL, mount it using OS X's hdid, copy the application (.app directory) to the specified destination (/Applications), and detach the image using hdiutil. The dmg file will be stored in the Chef::Config[:file_cache_path]. If you want to install an application that has already been downloaded (not using the source parameter), copy it to the appropriate location. You can find out what directory this is with the following command on the node to run chef:

knife exec -E 'p Chef::Config[:file_cache_path]' -c /etc/chef/client.rb

Optionally, the LWRP can install an "mpkg" or "pkg" package using installer(8).

Actions

:install - Installs the application.

Parameter attributes:

app - This is the name of the application used by default for the /Volumes directory and the .app directory copied to /Applications.
source - remote URL for the dmg to download if specified. Default is nil.
file - local dmg full file path. Default is nil.
owner - owner that should own the package installation.
destination - directory to copy the .app into. Default is /Applications.
checksum - sha256 checksum of the dmg to download. Default is nil.
type - type of package, "app", "pkg" or "mpkg". Default is "app". When using "pkg" or "mpkg", the destination must be /Applications.
volumes_dir - Directory under /Volumes where the dmg is mounted. Not all dmgs are mounted into a /Volumes location matching the name of the dmg. If not specified, this will use the name attribute.
package_id - Package id registered with pkgutil when a pkg or mpkg is installed
dmg_name - Specify the name of the dmg if it is not the same as app, or if the name has spaces.
dmg_passphrase - Specify a passphrase to use to unencrypt the dmg while mounting.
accept_eula - Specify whether to accept the EULA. Certain dmgs require acceptance of EULA before mounting. Can be true or false, defaults to false.
headers - Allows custom HTTP headers (like cookies) to be set on the remote_file resource.
allow_untrusted - Allows packages with untrusted certs to be installed.

Examples

Install /Applications/Tunnelblick.app from the primary download site.

dmg_package 'Tunnelblick' do
  source   'https://tunnelblick.net/release/Tunnelblick_3.7.0_build_4790.dmg'
  checksum '5053038aa8caf7dea66dcab11d6d240672216e6546eff4c2622e216c61af85e5'
  action   :install
end

Install Google Chrome. Uses the dmg_name because the application name has spaces. Installs in /Applications/Google Chrome.app.

dmg_package 'Google Chrome' do
  dmg_name 'googlechrome'
  source   'https://dl-ssl.google.com/chrome/mac/stable/GGRM/googlechrome.dmg'
  checksum '7daa2dc5c46d9bfb14f1d7ff4b33884325e5e63e694810adc58f14795165c91a'
  action   :install
end

Install Dropbox. Uses volumes_dir because the mounted directory is different than the name of the application directory. Installs in /Applications/Dropbox.app.

dmg_package 'Dropbox' do
  volumes_dir 'Dropbox Installer'
  source      'http://www.dropbox.com/download?plat=mac'
  checksum    'b4ea620ca22b0517b75753283ceb82326aca8bc3c86212fbf725de6446a96a13'
  action      :install
end

Install MacIrssi to ~/Applications from the local file downloaded to the cache path into an Applications directory in the current user's home directory. Chef should run as a non-root user for this.

directory "#{ENV['HOME']}/Applications"

dmg_package 'MacIrssi' do
  destination "#{ENV['HOME']}/Applications"
  action      :install
end

Install Virtualbox to /Applications from the .mpkg:

dmg_package 'Virtualbox' do
  source 'http://dlc.sun.com.edgesuite.net/virtualbox/4.0.8/VirtualBox-4.0.8-71778-OSX.dmg'
  type   'mpkg'
end

Install pgAdmin to /Applications and automatically accept the EULA:

dmg_package 'pgAdmin3' do
  source   'http://wwwmaster.postgresql.org/redir/198/h/pgadmin3/release/v1.12.3/osx/pgadmin3-1.12.3.dmg'
  checksum '9435f79d5b52d0febeddfad392adf82db9df159196f496c1ab139a6957242ce9'
  accept_eula true
end

Install Silverlight, with idempotence check based on pkgutil:

dmg_package 'Silerlight' do
  source     'http://silverlight.dlservice.microsoft.com/download/D/C/2/DC2D5838-9138-4D25-AA92-52F61F7C51E6/runtime/Silverlight.dmg'
  type       'pkg'
  checksum   '6d4a0ad4552d9815531463eb3f467fb8cf4bffcc'
  package_id 'com.microsoft.installSilverlightPlugin'
end

License & Authors

Author: Cookbook Engineering Team (cookbooks@chef.io)

Copyright: 2011-2017, Chef Software, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

dmg Cookbook CHANGELOG

This file is used to list changes made in each version of the dmg cookbook.

4.1.1 (2018-04-06)

The dmg_package resource is now included in Chef 14 and this cookbook has been deprecated. We highly recommend updating to Chef 14 so you can use this resource without the need for a cookbook dependency.
Validate the type field in the resource
Remove the now autogenerated ChefSpec matchers

4.1.0 (2017-11-15)

Adds allow_untrusted property for older packages that aren't signed
Resolve Chef 14 deprecation warnings
Minor testing updates and cleanup

4.0.0 (2017-04-27)

Converted the existing LWRP to a custom resource which increases the required chef-client release to 12.5+
Added Test Kitchen config with private atlas boxes for 10.10 and 10.11
Added a test recipe to installed Tunnelblick
Added an Inspec test to confirm that Tunnelblick actually installs
Remove unused attributes and the entire attributes file
Add a warning if you include the default recipe on your runlist
Update specs to run on 10.12 and against the test recipe since dmg::default is empty and the existing spec tested nothing

3.1.1 (2017-04-11)

Cookstyle updates
Test with Local Delivery and not Rake
Update apache2 license string
Remove foodcritic exclusions

3.1.0 (2017-01-18)

Fixed pkg,mpkg installation when it was using mounted app name while it was actually mounted under different name for some applications
Cookstyle fixes

3.0.0 (2016-09-06)

Add chef_version metadata
Run the specs against a mock of OS X
Testing updates
Require Chef 12+

v2.4.0 (2016-04-26)

Added support for local .dmg files with the file property. See the readme for details
Resolved all rubocop warnings

v2.3.0 (2015-10-20)

Add new headers property to the LWRP for custom http headers. See the readme for more information
Removed pivotal tracker example in the readme
Added travis and cookbook version badges to the readme
Added a .foodcritic file to exclude rules
Updated chefignore and .gitignore files
Updated platforms in Test Kitchen
Added standard Rubocop file
Updated Travis to test using ChefDK for the latest deps
Added a Berksfile
Updated contributing and testing docs
Updated Gemfile with the latest testing deps
Added maintainers.md and maintainers.toml
Added rakefile for simplified testing
Added source_url and issues_url metadata
Added basic converge chefspec

v2.2.2 (2014-11-12)

# 23, add chefspec matchers

v2.2.0 (2014-02-25)

[COOK-4285] Accept long EULAs

v2.1.4 (2014-01-26)

[COOK-4157] - dmg_package LWRP broken due to "puts" instead of "system"
[COOK-4065] - dmg cookbook outputs the name of packages when checking if they are installed

v2.1.2

Cleaning up merge errors

v2.1.0

Bug

COOK-3946 - Syntax error in resources/package.rb
COOK-2672 - EULA for package is displayed instead accepted

v2.0.8

Adding a Chef 10 compatibility check in provider

v2.0.6

BUG

[COOK-3302] - Sometimes hdiutil detach fails due to cfprefsd running in background

# IMPROVEMENT

Adding foodcritic and rubocop to .travis.yml

v2.0.4

Bug

COOK-3331 - Fix an issue where dmg_package with no source raises an exception

v2.0.2

Bug

COOK-3578 - Support package_ids with spaces
COOK-3302 - Fix an issue where hdiutil detach fails due to cfprefsd running in the background

v2.0.0

Bug

COOK-3389 - Use rsync instead of cp (potentially a breaking change on some systems)

v1.1.0

[COOK-1847] - accept owner parameter for installing packages

v1.0.0

[COOK-852] - Support "pkg" in addition to "mpkg" package types

v0.7.0

[COOK-854] - use cp -R instead of cp -r
[COOK-855] - specify a file or directory to check for prior install

v0.6.0

option to install software that is an .mpkg inside a .dmg
ignore failure on chmod in case mode is already set, or is root owned

Collaborator Number Metric

4.1.1 failed this metric

Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

4.1.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Cookstyle Metric

4.1.1 failed this metric

Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): dmg/resources/package.rb: 1

Run with Cookstyle Version 7.32.1 with cops Chef/Deprecations,Chef/Correctness,Chef/Sharing,Chef/RedundantCode,Chef/Modernize,Chef/Security,InSpec/Deprecations

No Binaries Metric

4.1.1 passed this metric

Testing File Metric

4.1.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric

4.1.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

Select Badges

Select Supported Platforms

Select Status

The dmg cookbook has been deprecated

dmg (25) Versions 4.1.1 4.1.1 4.1.0 4.0.0 3.1.1 3.1.0 3.0.0 2.4.0 2.3.0 2.2.2 2.2.0 2.1.4 2.1.2 2.1.0 2.0.8 2.0.6 2.0.4 2.0.2 2.0.0 1.1.0 1.0.0 0.7.0 0.6.0 0.5.2 0.5.1 0.5.0 Follow34

dmg Cookbook

Requirements

Platforms

Chef

Cookbooks

Resources/Providers

dmg_package

Actions

Parameter attributes:

Examples

License & Authors

Dependent cookbooks

Contingent cookbooks

dmg Cookbook CHANGELOG

4.1.1 (2018-04-06)

4.1.0 (2017-11-15)

4.0.0 (2017-04-27)

3.1.1 (2017-04-11)

3.1.0 (2017-01-18)

3.0.0 (2016-09-06)

v2.4.0 (2016-04-26)

v2.3.0 (2015-10-20)

v2.2.2 (2014-11-12)

v2.2.0 (2014-02-25)

v2.1.4 (2014-01-26)

v2.1.2

v2.1.0

Bug

v2.0.8

v2.0.6

BUG

v2.0.4

Bug

v2.0.2

Bug

v2.0.0

Bug

v1.1.0

v1.0.0

v0.7.0

v0.6.0

Collaborator Number Metric 4.1.1 failed this metric Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric 4.1.1 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

No Binaries Metric 4.1.1 passed this metric

Testing File Metric 4.1.1 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric 4.1.1 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Details

Updated April 6, 2018 Created on March 2, 2011

Supported Platforms

License

dmg (25) Versions 4.1.1 Follow34

Collaborator Number Metric

4.1.1 failed this metric

Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

4.1.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

No Binaries Metric

4.1.1 passed this metric

Testing File Metric

4.1.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric

4.1.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number