TweetFollow Us on Twitter

MacEnterprise: Packaging for Distribution

Volume Number: 25 (2009)
Issue Number: 01
Column Tag: MacEnterprise

MacEnterprise: Packaging for Distribution

Building Installer packages for software distribution

by Greg Neagle, MacEnterprise.org

Packing things up

Previously in MacTech, we looked at modifying Firefox in order to implement custom default preferences. This involved modifying several files inside the application bundle. If you made similar modifications for your environment, you'd then be faced with the next task: distributing the modified application to all your managed machines.

There are many ways to distribute software to Mac OS X machines, but most commercial products - Apple's and third-parties' - rely on Apple Installer packages to install and update software. This can be a convenient approach when the software you want to distribute is already packaged in that format, but you'll find there are several situations in which you need to create your own Installer packages:

1. The software is not distributed in Apple package format by the vendor, and your software distribution mechanism does not support the alternate format.

2. The vendor uses the Apple package format but the package will not install without user input - or, stated a different way, the package cannot be installed "silently".

3. You need to make changes in the files that are distributed, or distribute additional files.

4. You have internally-developed software that must be distributed. If you're lucky, your internal developer will package it for you. If you're not lucky, or you are the developer, then you need to do it.

Therefore, packaging software for distribution is a common task for OS X administrators. Fortunately, there are a lot of available tools to help you with this task.

Packaging Tools

A partial and by no means complete list of packaging and related tools for OS X in no particular order:

PackageMaker

http://www.apple.com/support/downloads/serveradmintools1055.html

This is Apple's utility for creating packages. It is available as part of the Xcode Tools, and also included with the Server Admin Tools. It can create every package format supported by Apple: old-style bundle packages, new-style flat packages, metapackages, distribution packages, and hybrid packages that work on multiple OS versions. The link above is for the 10.5.5 release of the Server Admin Tools; there may well be a newer release by the time this article reaches print.

Pros: PackageMaker is a supported Apple tool and is free. Many of the other tools rely on PackageMaker for at least some of their functionality.

Cons: It's hard to use, and had a history of buggy releases.

Iceberg

http://s.sudre.free.fr/Software/Iceberg.html

Iceberg is freeware by Stéphan Sudre, licensed with a BSD-style license. Capable and well-documented, Iceberg is very popular among Mac OS X administrators. It can create packages and metapackages, but not the newer distribution packages and flat packages.

Pros: Easy to use and free. It supports creation of packages from filesystem snapshots, as well as manual assembly of package contents.

Cons: Iceberg's installer installs a StartupItem that launches an always-on background task. This makes some admins uncomfortable.

LANrev InstallEase

http://www.lanrev.com/solutions/installease.shtml

LANrev, the maker of a cross-platform system management tool, recently made their InstallEase package creation utility freely available.

Pros: Ease of use, the ability to export Iceberg project files, and the creation of "uninstall" packages - packages that will uninstall software installed by another package. Creation of packages from filesystem snapshots.

Cons: It does not work standalone. To actually create packages, you must have Apple's PackageMaker and/or Iceberg installed as well.

Casper Composer SE

http://www.jamfsoftware.com/products/composer.php

Composer is a $100 utility from JAMF Software. Part of the Casper Suite of OS X client management tools, Composer is also available separately. Casper Composer creates packages based on filesystem snapshots. When used with the Casper suite, it can create installation packages with extra abilities such as installing default preferences into users' home directories.

Pros: Easy to use. Good documentation.

Cons: It's not free. Casper Composer requires Apple's PackageMaker to build standard Apple packages. Composer's special package features work only with other tools in the Casper Suite.

Helpful tools:

logGen

http://www.lsa.umich.edu/lsait/admin/mac/software/index.asp

logGen is freeware from the University of Michigan, by Phil Holland and Dave Pugh. It is a command-line utility for finding filesystem changes. You could use it as part of a package creation workflow together with pkgGen (described below) and PackageMaker.

pkgGen

http://blog.irisink.com/?p=106

This is a script by Zack Smith that parses the output of logGen and creates a "fauxroot" directory containing all the files and directories found by logGen. This fauxroot directory can then be used by PackageMaker or Iceberg to create an Installer package. The workflow would look something like:

  • Run logGen to create a "before" snapshot.

  • Install and configure software.

  • Run logGen to create an "after" snapshot and differences list.

  • Edit the differences list to remove unwanted items.

  • Run pkgGen with the edited difference list to create a fauxroot directory with copies of all needed files and directories.

  • Run PackageMaker and use the fauxroot directory to create your package.

Example Packaging Workflow

Let's use one of the tools to build an installation package for our modified Firefox. I'll use LANrev InstallEase for this example.

We'll start by assuming you already have an appropriately modified version of Firefox on your system, and have downloaded and activated a copy of InstallEase from LANrev's website.

Launch InstallEase.


Click Start to begin. You may optionally check No longer show this screen to skip the introduction in the future.


Since the Firefox application is self-contained within its own application bundle, we can save a bunch of time and create the package manually. You can do this any time you already know which files and folders you need. Select Manually and click Continue.


Ignore the confusing messages about snapshots; by choosing to create a package manually, you skipped the snapshot process. You are now looking at an empty package. Add the Firefox application to the package by simply dragging it in from the Finder:


After dropping Firefox into InstallEase's window, it should look like this:


You can examine the contents of the Firefox app bundle if you'd like, and make changes to the owner, group, and permissions of all the included files and folders if you wish. When you are satisfied, click Continue.


You have several options, and they are not exclusive - you can select as many as you want.

  • Apple Installer (.pkg): This is the default. You'll need Apple's PackageMaker utility installed to use this.

  • Uninstaller package for Apple Installer (.pkg): this is an interesting feature of InstallEase. It uses the installation package information to create a special package that contains a post-install script that removes the files and folders defined in the package. You can then use any software distribution system that relies on Apple's Installer (or command-line installer tool) to remove software as well.

  • Iceberg project (.packproj): Creates a project file for use with Iceberg. This allows you to use Iceberg to edit package options before creating the actual package.

  • Disk image with added files and folders (.dmg): this is mostly useful for use with LANrev's other tools - it creates a disk image that simply contains all the files and folders you've added to the package.

For this sample workflow, all we need and want is a standard Apple Installer package, so click Create.... You'll be asked where to save the package and for a filename. In most cases, you'll be asked to authenticate as an administrator. After a few moments, you should see something like this:


You are done with this simple example and now have a package that will install your custom version of Firefox.

Note that you had no chance to specify any package options, like whether or not the package requires a restart or if the package can be installed only on the startup disk. If you need to specify additional options, you are probably better off saving an Iceberg project and finishing your editing in Iceberg before creating the final package.

Another Example

Let's do a slightly more complicated example, this time using filesystem snapshots. Again we'll use InstallEase, but the process is similar in Iceberg and Casper Composer.

Launch InstallEase and select Automatically as the package creation method.


Click Continue.


Choose the source for the snapshot. In almost every case it will be the startup disk. In this example, the startup disk is named "Leopard". InstallEase by default ignores a lot of items on the disk when making snapshots to reduce the number of false positives. You can view and edit the list of excluded items by clicking the Adjust File Filter... button.


For this example, we'll leave everything at the default settings. Click OK to dismiss the exclusion editor, and click Take Snapshot to start the "before" snapshot.


You'll wait several minutes as InstallEase scans the disk and records information about exisiting filesystem items. Note that it was scanning my FileVault-protected home directory at the moment I took the screenshot. More on that in a bit. When it's done scanning the disk, you'll see this:


Now it's time to install your software. For this example, we'll install TextWrangler 2.3. Normally this is a drag-and-drop install, and so would need to be repackaged to be able to be pushed out with ARD or most other installation methods.


Download the TextWrangler 2.3 disk image from Bare Bones' website and open the disk image. Install the app by dragging it to the Applications folder, authenticating as an admin when requested.

If you were to package TextWrangler now, you'd have a working application, but you'd be missing the command line tools that come with the application. Worse, when your users launched TextWrangler for the first time, they'd be asked for an admin password in order to install the command line tools. To prevent that, we'll do it in advance and add it to the installation package. Launch /Applications/TextWrangler.app, and you should see this:


Authenticate as an administrator, then quit TextWrangler. Now we can return to InstallEase and click Take Snapshot. After InstallEase scans the disk for changes, you should see something like this:


I've turned down most of the disclosure triangles so you can see what InstallEase has found. Note that it found not only the main TextWrangler application in the Applications folder, but found the command line tool (/usr/bin/edit) and its man page. Without a snapshot utility, it might have been difficult to determine what items were actually installed when the command line tools were added.

We'll want to make a few changes before proceeding. First, InstallEase found changes in my home directory. Unfortunately, since I have a FileVault protected home directory, all it found was a changed "gneagle.sparseimage", so I don't know exactly what changed, but I'm fairly certain I don't care, so I'm going to remove /Users and everything below it.

You may be tempted to edit the exclusion list to always exclude /Users. Resist that temptation. Some software installs items in /Users/Shared which you'll want to capture. Also, it might be useful to see what files are created in a user's home directory on the first launch of an application. (In which case, using an account with a FileVault-protected home directory to install that software is probably a bad idea.) You probably won't want to include user files in an installation package, but you may need to manage them some other way or at least be aware of them.

There's another change to make before we build the package. Note that the TextWrangler application is owned by gneagle. That won't prevent TextWrangler for working on other systems, but it really would be better if we set the ownership to root or a local admin account to match other installed applications.


Here are the changes completed: the /Users folder and its contents have been removed, and the ownership of TextWrangler has been changed to root. Note that TextWrangler is actually an application bundle, so you actually have to expand the contents and change the ownership of every included item individually, which quickly gets tedious. Unfortunately, there seems to be no easy way to propagate changes recursively. We can now click Continue and choose our package formats and create the package just like in the first example.


Packing it in

No matter what tool you use, the basic concepts behind creating installation packages for OS X are the same. Different tools have different options and abilities - you may need to experiment with a few to find the ones that meet your needs.


Greg Neagle is a member of the steering committee of the Mac OS X Enterprise Project (macenterprise.org) and is a senior systems engineer at a large animation studio. Greg has been working with the Mac since 1984, and with OS X since its release. He can be reached at gregneagle@mac.com.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

iFFmpeg 6.4.0 - Convert multimedia files...
iFFmpeg is a comprehensive media tool to convert movie, audio and media files between formats. The FFmpeg command line instructions can be very hard to master/understand, so iFFmpeg does all the hard... Read more
Thunderbird 52.2.0 - Email client from M...
As of July 2012, Thunderbird has transitioned to a new governance model, with new features being developed by the broader free software and open source community, and security fixes and improvements... Read more
Airfoil 5.6.1 - Send audio from any app...
Airfoil allows you to send any audio to AirPort Express units, Apple TVs, and even other Macs and PCs, all in sync! It's your audio - everywhere. With Airfoil you can take audio from any... Read more
Apple Remote Desktop Client 3.9.3 - Clie...
Apple Remote Desktop Client is the best way to manage the Mac computers on your network. Distribute software, provide real-time online help to end users, create detailed software and hardware reports... Read more
jAlbum Pro 14.0 - Organize your digital...
jAlbum Pro has all the features you love in jAlbum, but comes with a commercial license. You can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly... Read more
jAlbum 14.0 - Create custom photo galler...
With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly, with pro results - Simply drag and drop photos into groups, choose a design... Read more
Vitamin-R 2.48 - Personal productivity t...
Vitamin-R creates the optimal conditions for your brain to work at its best by structuring your work into short bursts of distraction-free, highly focused activity alternating with opportunities for... Read more
Beamer 3.3 - Stream any movie file from...
Beamer streams to your Apple TV.... Plays any movie file - Just like the popular desktop movie players, Beamer accepts all common formats, codecs and resolutions. AVI, MKV, MOV, MP4, WMV, FLV. To... Read more
Shredo 1.2.2 - $9.99
Shredo is a beautiful, functional file-shredding and privacy scan utility. It permanently shreds files, folders, and external volumes' contents to keep information secure and impossible for anyone to... Read more
Final Draft 10.0.3 - Industry-leading sc...
Final Draft allows you to use your creative energy to focus on the content; let Final Draft take care of the style. Final Draft is the number-one selling application specifically designed for writing... Read more

Latest Forum Discussions

See All

The House of da Vinci (Games)
The House of da Vinci 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: Enter The House of Da Vinci, a new must-try 3D puzzle adventure game. Solve mechanical puzzles, discover hidden... | Read more »
Solve the disappearance of history’s gre...
Blue Brain Games invites you to indulge in an immersive hands-on 3D puzzle adventure in similar vein to The Room series, with its debut release The House of Da Vinci. Set during the historic period of the Italian Renaissance (when Leonardo himself... | Read more »
Age of Rivals (Games)
Age of Rivals 3.3 Device: iOS Universal Category: Games Price: $.99, Version: 3.3 (iTunes) Description: Deep civilization-building strategy in a fast-paced card game! | Read more »
Panthera Frontier (Games)
Panthera Frontier 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: | Read more »
Angry Birds Evolution beginner's gu...
Angry Birds changes things up a fair bit in its latest iteration, Angry Birds Evolution. The familiar sling-shot physics mechanics are still there, but the game now features team-based gameplay, RPG elements, and a new top-down view. With all of... | Read more »
Sega Forever is for the retro game fans
Sega is launching a new retro games service titled Sega Forever, in a move that's sure to delight games enthusiasts with a bit of nostalgia. Sega's releasing five classic games for free. The titles include Sonic the Hedgehog, Phantasy Star II,... | Read more »
The Little Acre (Games)
The Little Acre 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Lovely adventure game 'The Little A...
The Little Acre makes its way from PC to iOS today and it's a real charmer. It's a lovely little adventure game set in 1950's Ireland, gorgeously animated in a style slightly reminiscent of old Disney films. The game won a lot of praise for its... | Read more »
Futurama: Worlds of Tomorrow officially...
Futurama: Worlds of Tomorrow arrives next Thursday, and it features . . . Stephen Hawking? Turns out a few of your favorite science super stars, including Bill Nye, Neil DeGrasse Tyson, and George Takei will be making an appearance alongside the... | Read more »
MU Origin’s new update offers exciting c...
MU Origin is kicking off the summer with style. Its latest update is a real doozy, offering up plenty of fresh content. New challenges, some extra help for newcomers, and new costumes are just a few of the things you will find in the new patch. | Read more »

Price Scanner via MacPrices.net

Clearance 2016 MacBook Pros available for up...
B&H Photo has clearance 2016 13″ and 15″ MacBook Pros in stock today and on sale for up to $400 off original MSRP. Shipping is free, and B&H charges NY & NJ sales tax only: - 15″ 2.7GHz... Read more
Apple Ranks 9th In comScore Top 50 U.S. Digit...
comScore, Inc. has released its monthly ranking of U.S. online activity at the top digital media properties for May 2017 based on data from comScore Media Metrix Multi-Platform. * Entity has... Read more
10.5-inch iPad Pros available for up to $20 o...
B&H Photo has the new 2017 10.5″ iPad Pros available for up to $20 off MSRP including free shipping plus NY & NJ sales tax only: - 64GB iPad Pro WiFi: $649 - 256GB iPad Pro WiFi: $749 - 512GB... Read more
Three Off-The-Beaten-Track iOS Apps That Dese...
One of the great things about using iPads and iPhones is the vast selection of apps available for most anything you want or need to do. The three outlined in this article have been in my core app... Read more
Apple No. 1 Spot In Gartner Top 100 Vendors i...
Gartner, Inc. has unveiled the top global 100 vendors in IT in 2016 based on their revenue across IT (excluding communication services) and component market segments. In the Gartner Global Top 100:... Read more
Clearance iMacs available for up to $300 off...
B&H Photo has clearance 21″ and 27″ Apple iMacs available starting at $949, each including free shipping plus NY & NJ sales tax only: - 27″ 3.3GHz iMac 5K: $1999 $300 off original MSRP - 27″... Read more
1.4GHz Mac mini, refurbished, available for $...
The Apple Store has Apple Certified Refurbished 1.4GHz Mac minis available for $419. Apple’s one-year warranty is included, and shipping is free. Their price is $80 off MSRP, and it’s the lowest... Read more
Free Mixoo iOS Photo Editing App Gets Major U...
Button Software Technology has announced Mixoo 3.0, an important feature update to the company’s photo editor for iOS devices. Mixoo offers amazing ways to edit as well as decorate personal photo... Read more
FNable 2.0 Function Key Enabling Software Get...
Briksoftware has released FNable 2.0 With Touch Bar Support, a major new version of the function key enabling software now compatible with Touch Bar keyboards. FNable’s simplicity that allows users... Read more
Clearance 2016 12-inch Retina MacBooks, Apple...
Apple recently dropped prices on Certified Refurbished 2016 12″ Retina MacBooks, with models now available starting at $1019. Apple will include a standard one-year warranty with each MacBook, and... Read more

Jobs Board

*Apple* Solutions Consultant (Asc) - PT - Cu...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include:* Promoting Apple products and solutions Read more
Product Metrics Manager - *Apple* Media Pro...
- Identify blind spots in existing product metrics- Presenting on how Apple Media Products are used and perceived by our customers- Work with data science and Read more
*Apple* Professional Learning Specialist - A...
…Professional Learning Plans for educators in schools supported by Apple Professional Learning;Coordinate both leadership and teacher professional learning to Read more
Senior Payments Architect - *Apple* Pay - A...
…selected candidate will challenge assumptions and design solutions first and foremost with Apple 's customers in mind despite the complexity that is often behind the Read more
Product Manager, *Apple* News - Apple Inc....
…on new product areas, many of which have great potential impact to Apple .Drives the definition of broad, complex, and high impact products for worldwide markets, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.