Edit Ebuild: Package:VirtualBox

Documentation[edit]

Enter documentation or extended information for the ebuild below. Please add:

• An introduction to the ebuild that clearly explains what it does
• Usage information
• Hints, tips, and examples to ease configuration

If you need to add more complex wikitext, use the "Edit" button after saving this page, and enter your wiki text at the bottom. This allows you to provide rich documentation content for your Ebuild.

'''VirtualBox''' is a free and open source [https://www.wikipedia.org/wiki/Virtualization virtualization] '[https://www.wikipedia.org/wiki/Hypervisor hypervisor]' for x86-based machines. VirtualBox can be installed and run on GNU/Linux and other Operating Systems. The [https://en.wikipedia.org/wiki/Virtual_machine virtual machines] provided by VirtualBox can be used to run a number of guest Operating Systems such as GNU/Linux, Windows, and others. VirtualBox is available for Funtoo Linux on the ''arch'' profiles '''x86-32bit''', '''x86-64bit''' and '''pure-64'''. VirtualBox Homepage: https://www.virtualbox.org == Glossary of Terms == {{TableStart}} {{2ColHead|Term|Explanation}} {{2Col|'''''Host OS''''' |An install of Funtoo Linux on physical hardware. VirtualBox will be installed to and run from here.}} {{2Col|'''''Guest OS'''''|The Operating System that is run '''within a Virtual Machine''' provided by VirtualBox. The Guest OS could be Funtoo Linux, another GNU/Linux distribution, Windows, etc.}} {{2Col|'''''Guest Additions'''''|''Guest Additions'' is a collection of applications, libraries and kernel modules/drivers that are installed in your Guest OS. These provide support for graphics, networking, and other features such as file transfer and Guest access to real physical devices such as a USB flash drive.}} {{TableEnd}} == Host OS Installation == VirtualBox can be installed onto your Host OS - Funtoo Linux - using one of two packages: {{c|app-emulation/virtualbox}} or {{c|app-emulation/virtualbox-bin}}. The latter "-bin" package is a binary (precompiled) copy of VirtualBox. Installing this may be preferable on machines with low computing power. For a typical install, run {{console|body= ###i## emerge --ask app-emulation/virtualbox }} === Assign VirtualBox Users === Normal non-root users will not be able to use VirtualBox immediately after it has been installed. The Users that are to use VirtualBox must first become a member of the group {{c|vboxusers}}. For example, a user ''alice'' is added to {{c|vboxusers}} {{console|body= ###i## gpasswd -a alice vboxusers }} If currently logged in the User added to {{c|vboxusers}} must first log out before the changes will have an effect. === Load VirtualBox Kernel Modules === VirtualBox requires one or more Linux kernel modules to be loaded on the Host OS (Funtoo Linux) in order to function. As of VirtualBox version 5 these are provided by the package {{c|app-emulation/virtualbox-modules}} which is installed automatically (as a dependency) when you install app-emulation/virtualbox. As ''root '' load these modules in a terminal {{console|body= ###i## modprobe vboxdrv ###i## modprobe vboxnetadp ###i## modprobe vboxnetflt }} === Starting VirtualBox === * create the loading script: {{console|body= ###i##cat > /etc/vbox/vbox.cfg << EOF INSTALL_DIR=/opt/VirtualBox export QT_SCREEN_SCALE_FACTORS=1 export QT_SCALE_FACTOR=1 export QT_AUTO_SCREEN_SCALE_FACTOR=0 EOF }} VirtualBox can be started from a terminal. {{console|body= $##i## VirtualBox }} In a Desktop Environment, VirtualBox may also be run from a menu entry. Look for the names "VirtualBox" or "Oracle xVM VirtualBox" under menu categories "System" and/or "Emulator". === Funtoo Linux (Host OS) kernel updates === The VirtualBox kernel modules are compiled for the kernel present on the Host, Funtoo Linux. Each time that the Host kernel is updated or changed, the VirtualBox kernel modules must also be rebuilt. As is typical for most kernel changes or updates, please run {{console|body= ###i## emerge --ask @module-rebuild }} ''before'' running VirtualBox under the new kernel. If you wish to check that the VirtualBox kernel drivers will be rebuilt in this way, please examine the file {{f|/var/lib/module-rebuild/moduledb}}. For example, using the command {{c|grep}} {{console|body= $##i## grep virtualbox /var/lib/module-rebuild/moduledb a:1:app-emulation/##r##virtualbox##!r##-modules-5.0.20 }} == Guest OS Installation == {{note|If you're using a windows host use generic x86_64 funtoo stages.}} === Install Guest Additions === VirtualBox '''Guest Additions''' is a collection of applications, libraries and kernel modules/drivers that are installed in your Guest OS. These provide support for graphics, networking, and other features such as file transfer and Guest access to real physical devices such as a USB flash drive. ==== Funtoo or Gentoo Linux Guests ==== Following the successful installation of you Funtoo Linux ''Guest OS'' (that is within a Virtual Machine), install the package {{c|app-emulation/virtualbox-guest-additions}}. {{console|body= ###i## emerge --ask app-emulation/virtualbox-guest-additions }} Next, add your Guest OS Users to the group {{c|vboxguest}}. For example, a user ''bob'' is added to {{c|vboxguests}} {{console|body= ###i## gpasswd -a bob vboxguest }} Now add virtual-box-guest additions to the default runlevel of OpenRC. {{console|body= ###i## rc-update add virtualbox-guest-additions default }} Without having to reboot you can now start virtualbox-guest-additions within the Funtoo Guest OS with the command {{console|body= ###i## rc }} ==== Other GNU/Linux Guests ==== For other GNU/Linux, please refer to [https://www.virtualbox.org/manual/ch04.html#idp11274368 VirtualBox documentation]. ==== Microsoft Windows Guests ==== VirtualBox Guest Additions are installed in a Windows Guest by mounting a virtual CD-ROM image (.iso) within the guest virtual machine. In your Host OS Funtoo Linux, confirm the version of VirtualBox installed: For {{c|app-emulation/virtualbox}} {{console|body= $##i## emerge --pretend --quiet app-emulation/virtualbox [##g##ebuild##!g## ##y##R##!y## ] ##g##app-emulation/virtualbox-5.0.20##!g## }} '''For VirtualBox versions 4.x (less than 5.0)''' Under the earlier chapter [[ Package:VirtualBox#Host_OS_Installation|Host OS Installation ]], install {{c|app-emulation/virtualbox}} (or {{c|app-emulation/virtualbox-bin}}) with the USE flag {{c|additions}} enabled. This will provide the ISO necessary for installing Guest Additions within a Microsoft Windows guest. '''For VirtualBox versions 5.0 and above''' From version 5.0 the USE flag {{c|additions}} has been removed from the package app-emulation/virtualbox. The Guest Additions ISO required for a Windows-based Guest OS is now provided in a separate package, {{c|app-emulation/virtualbox-additions}}. Install this manually {{console|body= ###i## emerge --ask app-emulation/virtualbox-additions }} {{warning|The package app-emulation/'''virtualbox-additions''' installs the Guest Additions ISO on your Host OS (Funtoo Linux). This is what you mount in a VM with Windows as a Guest OS. The package app-emulation/'''virtualbox-guest-additions''' is different. This is the Guest Additions that you install ''inside of a VM'' that happens to be a Guest OS of Funtoo Linux or Gentoo Linux. The two packages perform different tasks so be sure to install the correct package!}} Mount the Guest Additions ISO {{f|/usr/share/virtualbox/VBoxGuestAdditions.iso}} inside of your Microsoft Windows guest. Within Windows, browse to and install VirtualBox Guest Additions. == Headless == To be able to use VRDP you have to install {{c|app-emulation/virtualbox-extpack-oracle.}} To verify if extpack installed and usable: {{console|body= ###i## VBoxManage list extpacks Extension Packs: 1 Pack no. 0: Oracle VM VirtualBox Extension Pack Version: 5.2.6 Revision: 120293 Edition: Description: USB 2.0 and USB 3.0 Host Controller, Host Webcam, VirtualBox RDP, PXE ROM, Disk Encryption, NVMe. VRDE Module: VBoxVRDP Usable: true Why unusable: }} Create a testvm using this command: {{console|body= ###i## VBoxManage createvm --name "testvm" Virtual machine 'testvm' is created. UUID: 7b19dc85-2991-4e6a-b1e9-e8e6704e75b4 Settings file: '/root/.VirtualBox/Machines/testvm/testvm.vbox' ###i## VBoxManage registervm /root/.VirtualBox/Machines/testvm/testvm.vbox ###i## VBoxManage list vms "testvm" {7b19dc85-2991-4e6a-b1e9-e8e6704e75b4} }} Specify the hardware configurations of the VM (ioapic is needed for SMP): {{console|body= ###i## VBoxManage modifyvm testvm --memory 1024 --cpus 4 --ioapic on --acpi on --boot1 dvd --nic1 bridged --bridgeadapter1 eth0 --ostype Linux_64 }} {{note|Enabling the I/O APIC is required for 64-bit guest operating systems, especially Windows Vista; it is also required if you want to use more than one virtual CPU in a virtual machine.}} Create disk image: {{console|body= ###i## VBoxManage createmedium --filename ~/VirtualBox\ VMs/testvm/testvm-disk01.vdi --size 10000 0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100% Medium created. UUID: 0234cd8e-617a-435b-bed4-9aee99a0f34a }} Resize HDD to 50 GB. {{console|body= ###i## VBoxManage modifymedium ~/VirtualBox\ VMs/testvm/testvm-disk01.vdi --resize 50000 0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100% Medium created. UUID: 0234cd8e-617a-435b-bed4-9aee99a0f34a }} Add a SCSI controller: {{console|body= ###i## VBoxManage storagectl testvm --name "SATA Controller" --add sata }} Attach install CD-ROM iso image and disk image: {{console|body= ###i## VBoxManage storageattach "testvm" --storagectl "SATA Controller" --port 0 --device 0 --type hdd --medium /root/VirtualBox\ VMs/testvm/testvm-disk01.vdi ###i## VBoxManage storageattach "testvm" --storagectl "SATA Controller" --port 1 --device 0 --type dvddrive --medium /root/iso/systemrescuecd-x86-5.1.0.iso }} {{console|body= ###i## VBoxHeadless --startvm "testvm" -v on & }} The above command will launch the VM, as well as VRDE remote desktop server. The remote desktop server is needed to access the headless VM's console. By default, the VRDE server is listening on TCP port 3389. After install you might want to remove the install CD from the drive like this. {{console|body= ###i## VBoxManage storageattach "testvm" --storagectl "SATA Controller" --port 1 --device 0 --type dvddrive --medium none }} == Tips and Tricks == === Share a generic virtual machine === Virtualbox supports exporting virtual machines to OVA format that can be subsequently loaded to vmware player, virtualbox, KVM/qemu, and microsoft's virtual machine management software. * in virtualbox manager: select powered off virtual machine to export. * ctrl + e to open the export virtual machine dialogue. * review format settings, or just hit next. * review appliance settings, and finish. === Configure Video within Funtoo Linux Guests === {{note|This section is being developed.}} For Funtoo, Gentoo and other GNU/Linux ''Guest OS'' the [https://ww.wikipedia.org/wiki/X_Window_System X Window System] can be optimized for running within a VirtualBox virtual machine. First, enable VBoxSVGA on virtual machine (there may be problems with VMSVGA as it needs the vmware driver). In a Funtoo Linux ''Guest OS'', modify the file {{f|/etc/portage/[[make.conf]]}} to include the following line {{file|name=/etc/portage/make.conf|body= VIDEO_CARDS="virtualbox" }} Then, reinstalling the xorg-server and xorg-drivers, will let X.Org work in "Guest OS" {{console|body= ###i## emerge x11-base/xorg-server x11-base/xorg-drivers }} === Providing USB2, USB3, VRDP and/or PXE Boot ROM to Guest OS === {{note|This section is being developed.}} Accept PUEL licence emerge app-emulation/virtualbox-extpack-oracle == Troubleshooting == === EFI case === latest releases of virtualbox have a volatile NVRAM and this makes an EFI guest boot troublesome. To workaround this following steps required: * remove any CD images (like systemrescuecd) from the VM settings * start the VM * wait for the countdown or press Esc immediately to reach the EFI shell * type <code>edit startup.nsh</code> to open the full-screen editor * enter <code>"fs0:\EFI\Funtoo Linux [GRUB]\grubx64.efi" </code> (including the double quotes, since the path contains spaces) * press <code>CTRL-s</code> (maybe twice) to save and confirm saving by pressing Enter * quit editor by pressing <code>CTRL-q</code> * type <code>reset</code> to reboot the machine (or kill the VM and boot it using the GUI) * wait for the countdown or press Enter to immediately run the startup.nsh script EFI guests now should properly boot. reference reports: https://www.virtualbox.org/ticket/14279 and https://bugs.funtoo.org/browse/FL-2640 An alternative workaround is to rename the grub EFI binary to take advantage of the EFI default boot behavior. During installation, when installing a boot-loader, do these additional steps: * Create a folder under <code>/boot/EFI</code> called <code>BOOT</code> * Copy <code>/boot/EFI/Funtoo Linux [GRUB]/grubx64.efi</code> to <code>/boot/EFI/BOOT/BOOTX64.EFI</code> [[Category:Ebuilds]] [[Category:Virtualization]]

Save page Show preview Show changes Cancel