Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 44 lines (31 sloc) 1.675 kb
e0f45a3 @pwnall Initial commit to virtual_box.
authored
1 = virtual_box
2
e2244ec @pwnall Initial feature set.
authored
3 This gem is a Ruby API for VirtualBox, Sun's open-source virtualization software
4 that supports Linux, Mac OS X, and Windows.
5
6 == Features
7
8 Currently, the gem supports the following features:
9 * VM creation and removal
10 * VM start, and stop
11 * Disk (VDI, VMDK, VHD) and DVD (ISO) images
12 * NAT, bridged, host-only and internal networking
13 * DHCP configuration for host-only and internal networks
14 * VirtualBox version detection (OSE vs. regular)
15
16 == Requirements
17
18 The gem requires that the VirtualBox command-line tools are installed and on
19 the system's binary path. The gem is developed against the documentation for
20 VirtualBox 3.
21
22 == Limitations
23
24 This gem makes some simplifying assumptions (rails people would say it is
25 opinionated).
26
27 * VM configuration XML file management is completely delegated to VirtualBox;
28 the gem assumes and enforces the invariant that all XML files map to registered
29 VMs
e0f45a3 @pwnall Initial commit to virtual_box.
authored
30
31 == Contributing to virtual_box
32
33 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
34 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
35 * Fork the project
36 * Start a feature/bugfix branch
37 * Commit and push until you are happy with your contribution
38 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
39 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
40
41 == Copyright
42
e2244ec @pwnall Initial feature set.
authored
43 Copyright (c) 2010 Victor Costan. See LICENSE.txt for further details.
Something went wrong with that request. Please try again.