vagrant-notify

A Vagrant plugin that forwards notify-send from guest to host machine and notifies provisioning status. See it in action

Installation

Make sure you have Vagrant 1.4+ around and run:

$ vagrant plugin install vagrant-notify

Usage

notify-send from guest VMs

Whenever you run vagrant up, a Ruby TCPServer will fire up on a port within the usable port range and a Ruby script will be copied over to the guest machine to replace the original notify-send command.

Provisioning notification

Apart from redirecting notify-send from the guest VM to the host, whenever a Vagrant 1.4+ provisioner starts or completes running you'll also receive notifications like:

Linux

Since Linux distributions have notify-send pre-installed, everything should work out of the box.

OS X

Check out our OS X notify-send compatible scripts.

Windows

Check out our Windows notify-send compatible scripts.

Configuration

Notification server is enabled by default on all guests. You can individually disable the plugin by adding a false boolean to the notify.enable option in your Vagrantfile configuration block

Vagrant.configure(2) do |config|
  config.vm.box = "ubuntu/trusty64"
  config.notify.enable = false
end

Please note that as of v0.5.1, the notification server will automatically be disabled for any of the following cloud providers.

By default, the notification server is binded to local interfaces. For networking different than your provider's default network configuration, you can use the notify.bind_ip configuration option to bind the notification server onto a different local ip address.

Vagrant.configure(2) do |config|
  config.vm.box = "ubuntu/trusty64"
  config.notify.bind_ip = "192.68.56.20"
end

By default local server uses notify_send command for displaying notifications, there is a possibility to use different app without wrapper scripts:

• notify.sender_app configuration option is used for specifing application name (default: notify-send)
• notify.sender_params_str defines how params for applications will be passed (default: [--app-name {app_name}] [--urgency {urgency}] [--expire-time {expire_time}] [--icon {icon}] [--category {category}] [--hint {hint}] {message}). You can use these variables (escaped by { and } characters) here:
  • urgency - urgency level for notification
  • expire_time - when notification will expire?
  • app_name - application name
  • icon - icon for the notification (can be multiple, devided by comma)
  • category - category for the notification (can be multiple, devided by comma)
  • hint - icon for the notification (need to use this format: TYPE:NAME:VALUE)
  • message - message to send
• notify.sender_params_escape - should params will be escaped when passed to script (default: true)

This is example how to to run notifications with build-in MacOS X notifications support:

Vagrant.configure(2) do |config|
  config.vm.box = "ubuntu/trusty64"
  config.notify.sender_params_str = '-e \'display notification {message} sound name \"default\"\''
  config.notify.sender_app = 'osascript'
  config.notify.sender_params_escape = true
end

WARNING

Do NOT bind the notification server to an IP accessible over a network! The notification server does not have any authentication and doing so will leave your system vulnerable to remote command execution.

Providers and Guests

vagrant-notify supports the following providers:

• VirtualBox
• Docker
• Hyper-V
• LXC
• Parallels
• VMWare Fusion
• VMWare Workstation

vagrant-notify has been tested and known to work with Linux, Solaris 11, FreeBSD, OpenBSD, and NetBSD guests. (notify-send icon forwarding feature is not supported on BSD guests)

Demo

Known issues

• On rare occasions the notification server may stop receiving notifications if the host is suspended/hibernates. The notification server may need to be manually restarted if that's the case. vagrant notify --restart

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request