doc/README.vagrant

   1 1. Introduction
   2
   3 Vagrant is a virtual machine management program that makes it trivial to build
   4 and configure reproducible virtual machines. Wireshark comes with a Vagrantfile
   5 which will set up a complete Ubuntu development environment in a virtual
   6 machine, including all necessary compilers, dependent libraries, and tools like
   7 valgrind.
   8
   9 Using vagrant can greatly simplify setup for new developers, at the cost of
  10 running your builds in a virtual machine, thus with reduced performance.
  11
  12 2. Installation
  13
  14 Vagrant requires VirtualBox to be installed, as that is the backing virtual
  15 machine technology it uses. Install it first from https://www.virtualbox.org/.
  16
  17 Now install vagrant itself from https://www.vagrantup.com/.
  18
  19 3. Setup
  20
  21 With virtualbox and vagrant installed, setting up your VM is as simple as
  22 running `vagrant provision` in the wireshark source directory. This will
  23 download, install and configure a complete Ubuntu development environment. It
  24 will also mount the Wireshark source directory into the VM, and run an
  25 out-of-tree cmake build into the ~/build directory of the VM.
  26
  27 4. Usage
  28
  29 Running `vagrant ssh` from the wireshark source directory will put your shell
  30 into the VM. Running `make` inside the `~/build` directory of the VM will
  31 build wireshark based on whatever is in your source tree.