Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 81 lines (51 sloc) 2.852 kb
5d5dfb6 @mitchellh Abandon project. Check the README.
authored
1 **This gem is no longer under active development. Please do not use it.**
2
3 I've decided to stop developing this library since the main user of the library
4 and the purpose it was created (Vagrant) no longer makes use of it. The reasoning
5 behind this is because the `win32ole` support on Windows is simply painful and
6 doesn't support all the features necessary to fully support the VirtualBox
7 API.
8
9 If you're interested in maintaining this gem, please contact me (mitchellh).
10
205e560 @mitchellh Basic readme
authored
11 # VirtualBox Ruby Gem
12
0da227e @AlekSi Remove trailing whitespace in all files.
AlekSi authored
13 The VirtualBox ruby gem is a library which allows anyone to control VirtualBox
205e560 @mitchellh Basic readme
authored
14 from ruby code! Create, destroy, start, stop, suspend, and resume virtual machines.
15 Also list virtual machines, list hard drives, network devices, etc.
16
8a649c5 @mitchellh Updated installation instructions
authored
17 ## Installation and Requirements
18
19 First you need to install [VirtualBox](http://www.virtualbox.org/) which is available for
20 Windows, Linux, and OS X. After installation, install the gem:
a38406a @mitchellh Basic VM saving is in. Nic relationship.
authored
21
22 sudo gem install virtualbox
23
9eda9d8 @mitchellh Merge in the native interfacing branch. Gem now uses the native interfac...
authored
24 The gem uses the native COM interface with VirtualBox provides to communicate with
25 VirtualBox. On Windows, this is globally available. On Linux-based machines, the gem
26 uses Ruby-FFI to talk to a dynamic library. No configuration should be necessary.
8a649c5 @mitchellh Updated installation instructions
authored
27
a38406a @mitchellh Basic VM saving is in. Nic relationship.
authored
28 ## Basic Usage
29
9eea142 @mitchellh Readme updated.
authored
30 The virtualbox gem is modeled after ActiveRecord. If you've used ActiveRecord, you'll
0da227e @AlekSi Remove trailing whitespace in all files.
AlekSi authored
31 feel very comfortable using the virtualbox gem.
9eea142 @mitchellh Readme updated.
authored
32
0da227e @AlekSi Remove trailing whitespace in all files.
AlekSi authored
33 There is a [quick getting started guide](http://mitchellh.github.com/virtualbox/file.GettingStarted.html) to
307c9db @mitchellh Additional documentation. Added a getting started guide!
authored
34 get you acquainted with the conventions of the virtualbox gem.
35
9eea142 @mitchellh Readme updated.
authored
36 Complete documentation can be found at [http://mitchellh.github.com/virtualbox](http://mitchellh.github.com/virtualbox).
37
38 Below are some examples:
a38406a @mitchellh Basic VM saving is in. Nic relationship.
authored
39
40 require 'virtualbox'
0da227e @AlekSi Remove trailing whitespace in all files.
AlekSi authored
41
a38406a @mitchellh Basic VM saving is in. Nic relationship.
authored
42 vm = VirtualBox::VM.find("my-vm")
0da227e @AlekSi Remove trailing whitespace in all files.
AlekSi authored
43
9eea142 @mitchellh Readme updated.
authored
44 # Let's first print out some basic info about the VM
9eda9d8 @mitchellh Merge in the native interfacing branch. Gem now uses the native interfac...
authored
45 puts "Memory: #{vm.memory_size}"
0da227e @AlekSi Remove trailing whitespace in all files.
AlekSi authored
46
9eea142 @mitchellh Readme updated.
authored
47 # Let's modify the memory and name...
9eda9d8 @mitchellh Merge in the native interfacing branch. Gem now uses the native interfac...
authored
48 vm.memory_size = 360
9eea142 @mitchellh Readme updated.
authored
49 vm.name = "my-renamed-vm"
0da227e @AlekSi Remove trailing whitespace in all files.
AlekSi authored
50
9eea142 @mitchellh Readme updated.
authored
51 # Save it!
a38406a @mitchellh Basic VM saving is in. Nic relationship.
authored
52 vm.save
53
9eea142 @mitchellh Readme updated.
authored
54 ## Known Issues or Uncompleted Features
55
56 VirtualBox has a _ton_ of features! As such, this gem is still not totally complete.
57 You can see the features that are still left to do in the TODO file.
58
59 ## Reporting Bugs or Feature Requests
60
61 Please use the [issue tracker](https://github.com/mitchellh/virtualbox/issues).
a38406a @mitchellh Basic VM saving is in. Nic relationship.
authored
62
205e560 @mitchellh Basic readme
authored
63 ## Contributing
64
65 If you'd like to contribute to VirtualBox, the first step to developing is to
ac2be35 @mitchellh Update .gitignore and README for new bundler usage
authored
66 clone this repo, get [bundler](http://github.com/carlhuda/bundler) if you
205e560 @mitchellh Basic readme
authored
67 don't have it already, and do the following:
68
643026e @mitchellh Minor README update
authored
69 bundle install --relock
205e560 @mitchellh Basic readme
authored
70 rake
71
72 This will run the test suite, which should come back all green! Then you're good to go!
248258d @mitchellh Added "Special Thanks" to Readme
authored
73
74 ## Special Thanks
75
76 These folks went above and beyond with contributions to the virtualbox gem, and
77 for that, I have to say "thanks!"
78
79 * [Kieran Pilkington](http://github.com/KieranP)
643026e @mitchellh Minor README update
authored
80 * [Aleksey Palazhchenko](http://github.com/AlekSi)
Something went wrong with that request. Please try again.