Build iridium-browser for Windows using Vagrant

Prerequisites

• Make sure you have at least 75 GB free disk space.
• Install Vagrant.
• Install VirtualBox.
• Run bootstrap.sh. This will download the Visual Studio Community 2013 Update 4 ISO image (about 7 GB), the Windows Vagrant box (about 3.6 GB) and install the necessary Vagrant plugin.
• Currently supported host systems for bootstrap.sh are Linux and OSX. For Windows, the dependencies must be downloaded / installed manually and the Vagrantfile created from Vagrantfile.in.

Setup

Start the Vagrant box:

host$ vagrant up

This will also perform a checkout of the source code and start the compilation. The resulting installer will be located on your host in folder build_result.

If the virtual machine asks you to go to PC settings to activate Windows, open it and switch back to the desktop by moving the mouse to the top-left corner of the screen and clicking the small desktop.

Compile changes

After you did some changes to the code, you can login to the virtual machine and trigger compilation.

host$ vagrant ssh
guest$ c:\vagrant\scripts\windows\100_compile_release.cmd

If you also modified .gyp files, you will have to recreate the build scripts before compiling.

guest$ c:\vagrant\scripts\windows\080_runhooks.cmd

IMPORTANT: If you run vagrant provision, all local changes will be reset and overwritten with the default iridium-browser patches!

Build installer

To build a new installer, you can use one of the provisioning scripts:

host$ vagrant ssh
guest$ c:\vagrant\scripts\windows\110_build_msi_installer.cmd

Code signing

During the build process of the MSI installer, the included files (and the installer itself) can optionally be signed.

To enable this, put your codesigning certificate as codesign-certificate.spc and your private key as codesign-key.pvk in the vagrant root folder (next to the Vagrantfile).

Troubleshooting

If you receive this error while starting the virtual machine from a remote ssh shell:

The guest machine entered an invalid state while waiting for it
to boot. Valid states are 'starting, running'. The machine is in the
'aborted' state. Please verify everything is configured
properly and try again.

If the provider you're using has a GUI that comes with it,
it is often helpful to open that and watch the machine, since the
GUI often has more helpful error messages than Vagrant can retrieve.
For example, if you're using VirtualBox, run `vagrant up` while the
VirtualBox GUI is open.

the headless mode must be activated in Vagrantfile by changing

vb.gui = true

to

vb.gui = false

You can restart with vagrant up afterwards.