I wrote the original Boostrapper Manifest Generator (BMG) blog post a few years ago.
It is one of the most heavily visited pages on my site so I thought I should revisit it, and given that the BMG is so buggy it could be useful to have some screen shots.
I will provide 2 concrete examples of how to use the BMG to create a bootstrapper pre-requisite check.
All this is being done on a Windows 7 32-bit (Virtual) machine, with visual studio 2010 installed.
I have also downloaded and installed the BMG2008 which can be downloaded from here
The application that I am going to bootstrapper is a small test application called “GuidGenerator”, can you guess what it does?
I will be using a standard setup deployment project to create the installer.
Setup BMG 2008
- Download the BMG2008 from here
- Install the application and note the path that it is installed to as it does not create a short cut, (C:Program FilesMicrosoftBootstrapper Manifest Generator for VS2008), and create your own desktop shortcut
- Run the BMG
- Click “Tools :: Edit Machine Paths”
- You may get a message about the SDK not being installed etc etc. Get past the error message and you will need to set the path to your boot strap directory. Do a search on your file system for “bootstrapper” and you will find a folder somewhere like this (note the SDK path)
C:Program FilesMicrosoft SDKsWindowsv7.0ABootstrapper
Enter that into the path and choose OK.
You are now ready to create a bootstrapper
Note: This bootstrapper folder is important – read the tips and tricks at the end.
Example 1 – .Net Framework 4.0 Pre-requisite Check
- Download the DotNet framework full install from Microsoft here, and save to a location that you can find, mine is @ c:DownloadsdotNetFx40_Full_x86_x64.exe
- Run the BMG
- Click “File New”
- Choose “Package Manifest”, choose OK
- Choose “Add Install File”, (button in the top left)
- Browse to the .Net Framework that you downloaded earlier and click OK
- Display Name: enter a name for the bootstrapper, this is the name of the pre-requisite check that will show up in visual studio. I will call mine “My .net Framework 4.0 Check”
- Click back on the “Package” option which is the root of the tree menu on the left and set the Product Name to DotNet4Check – this becomes the name of the folder that the package is created in.
Note: You have to do it in this order as if you set the package name before adding a file it crashes the BMG.
- Click into the product code field and it will default with the “Product Name” just set, (otherwise this can throw a warning if left blank).
- System Checks
You want to set up a system check that fails if the condition is not met, or alternatively by-pass the install if a condition is met.
- Switch to the system checks tab
- Click on the registry check (2nd icon in the list)
- Property for Result: DotNet4RegCheck (note: this is the name of the check that is used later in the “Install Conditions” tab
- Enter the following registry key: HKLMSoftwareMicrosoftNET Framework SetupNDPv4Full
- Registry Value: Version
If it fails the check then it will prompt the user that they need to install the pre-requisite.
For the .Net Framework I have chosen to do a simple registry check for the .Net Framework version.
- Install Conditions
- Switch to the install conditions tab. This is where we define when our installer should be run.
- Type: ByPassIf
- Property: DotNet4RegCheck – (This is the name entered in the “Property for Result” field in the system check
- Comparison: Ver >=
- Value: 4.0.30319
- Exit Codes
Set the following: (Note: I am cheating as I am reverse engineering the .Net bootstrapper that comes with VS2010 to get these exit codes
0 – Success
3010 – Success with reboot
Leave all the other options with their defaults
- Build: Now we can build the package, (button top right)
- Results, note that in my case it succeeded with no errors, and the path contains the folder name that I entered in the product name field.
- Copy: Go to the output directory and copy the “DotNet4Check” folder to “C:Program FilesMicrosoft SDKsWindowsv7.0ABootstrapperPackages”
- Setup Project
- My project looks like this:
- Right Click on the Setup Project and choose properites
- On the properties window Click the “Pre-Requisites” button.
- Deselect anything that is selected that you do not require and choose your check.
- In this case I am going to say – “Download prerequisites from the same location as my application”
- Build the setup solution in release mode.
- Copy the release directory somewhere to a machine missing the pre-requisites. The release directory should look something like this, because we chose to set the download from the same location.
- Run the installer and you will see this…
- My project looks like this:
Example 2 – .Net Framework 4.0 Pre-requisite Check – web download
In this example we want to supply a web download version of the installer so you don’t have to distribute the requisite files with your installer.
This will be identical to the previous example with these changes:
- After adding the file you get the Properties tab. Enter the URL from the tips below in the “HomeSite URL” setting.
I used – http://go.microsoft.com/fwlink/?linkid=182805 for the .Net 4.0 Framework. (remember you must right-click and choose paste).
- When setting up the package pre-requisites choose to “Download Pre-requisites from the package vendors website”.
Repeat all the other steps and when you choose “install” from the bootstrapper prompt you should get a message that it is downloading.
Tips and Tricks
- The “Bootstrapper” directory is your friend (on my machine “C:Program FilesMicrosoft SDKsWindowsv7.0ABootstrapper”).
If you have access to a VS2010 installed machine and go to the bootstrapper directory and into the Packages folder and you will find bootstrappers for 19 different things, including .Net 3.5/4.0 and Client installation versions.
I suspect if you took a copy of the packages folder back to your older VS2005/2008 environment you would get the pre-requisites.
- If you don’t intend to set up exit conditions don’t switch to the “Exit Conditions tab”. if you do it will put an empty condition in that throws a warning at build time. The only way to get rid of it is to enter 0 / Success.
I suspect for things like .Net you want the user to be able to download the .exe directly. Here are the URL’s provided by the .Net bootstrappers installed with VS2010.
These are the small web installer based versions
- .Net Framework 3.5 SP1: http://go.microsoft.com/fwlink/?linkid=118076 download
- .Net Framework 3.5 Client: http://go.microsoft.com/fwlink/?LinkId=119637 download
- .Net Framework 4.0: http://go.microsoft.com/fwlink/?linkid=182805 download
- .Net Framework 4.0 Client: http://go.microsoft.com/fwlink/?linkid=182804 download
- My web install failed because on my Install I happened to click into the “Value” field and it put the following “N/A for ValueExists and ValueNotExists”. This created an “unexpected error” on install.
I went into the product.xml file and set value=”” and it worked.