diff options
author | David Reaver <johndreaver@gmail.com> | 2016-08-06 19:10:29 -0700 |
---|---|---|
committer | Rok Garbas <rok@garbas.si> | 2016-08-07 04:10:29 +0200 |
commit | ed4a061c34382f487b4da11fd4b8130ed215931a (patch) | |
tree | 43eec6b9c5518239436f8a78f57862c249b1b777 /nixos | |
parent | a741978f200a6627bfcb6325e340db09464a1af9 (diff) |
NixOS manual: Add docs for Virtualbox guest (#17454)
Fixes #13311
Diffstat (limited to 'nixos')
-rw-r--r-- | nixos/doc/manual/installation/installing-virtualbox-guest.xml | 89 | ||||
-rw-r--r-- | nixos/doc/manual/installation/installing.xml | 1 |
2 files changed, 90 insertions, 0 deletions
diff --git a/nixos/doc/manual/installation/installing-virtualbox-guest.xml b/nixos/doc/manual/installation/installing-virtualbox-guest.xml new file mode 100644 index 0000000000000..8fe61a5fdfdfc --- /dev/null +++ b/nixos/doc/manual/installation/installing-virtualbox-guest.xml @@ -0,0 +1,89 @@ +<section xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + version="5.0" + xml:id="sec-instaling-virtualbox-guest"> + +<title>Installing in a Virtualbox guest</title> +<para> + Installing NixOS into a Virtualbox guest is convenient for users who want to + try NixOS without installing it on bare metal. If you want to use a pre-made + Virtualbox appliance, it is available at <link + xlink:href="https://nixos.org/nixos/download.html">the downloads page</link>. + If you want to set up a Virtualbox guest manually, follow these instructions: +</para> + +<orderedlist> + + <listitem><para>Add a New Machine in Virtualbox with OS Type "Linux / Other + Linux"</para></listitem> + + <listitem><para>Base Memory Size: 768 MB or higher.</para></listitem> + + <listitem><para>New Hard Disk of 8 GB or higher.</para></listitem> + + <listitem><para>Mount the CD-ROM with the NixOS ISO (by clicking on + CD/DVD-ROM)</para></listitem> + + <listitem><para>Click on Settings / System / Processor and enable + PAE/NX</para></listitem> + + <listitem><para>Click on Settings / System / Acceleration and enable + "VT-x/AMD-V" acceleration</para></listitem> + + <listitem><para>Save the settings, start the virtual machine, and continue + installation like normal</para></listitem> + +</orderedlist> + +<para> + There are a few modifications you should make in configuration.nix. Enable + the virtualbox guest service in the main block: +</para> + +<programlisting> +virtualisation.virtualbox.guest.enable = true; +</programlisting> + +<para> + Enable booting: +</para> + +<programlisting> +boot.loader.grub.device = "/dev/sda"; +</programlisting> + +<para> + Also remove the fsck that runs at startup. It will always fail to run, + stopping your boot until you press <literal>*</literal>. +</para> + +<programlisting> +boot.initrd.checkJournalingFS = false; +</programlisting> + +<para> + Shared folders can be given a name and a path in the host system in the + VirtualBox settings (Machine / Settings / Shared Folders, then click on the + "Add" icon). Add the following to the + <literal>/etc/nixos/configuration.nix</literal> to auto-mount them: +</para> + +<programlisting> +{ config, pkgs, ...} : +{ + ... + + fileSystems."/virtualboxshare" = { + fsType = "vboxsf"; + device = "nameofthesharedfolder"; + options = [ "rw" ]; + }; +} +</programlisting> + +<para> + The folder will be available directly under the root directory. +</para> + +</section> diff --git a/nixos/doc/manual/installation/installing.xml b/nixos/doc/manual/installation/installing.xml index 073f7ca346209..04a186a1bca68 100644 --- a/nixos/doc/manual/installation/installing.xml +++ b/nixos/doc/manual/installation/installing.xml @@ -271,5 +271,6 @@ drive (here <filename>/dev/sda</filename>). <xref linkend="ex-config" <xi:include href="installing-uefi.xml" /> <xi:include href="installing-usb.xml" /> <xi:include href="installing-pxe.xml" /> +<xi:include href="installing-virtualbox-guest.xml" /> </chapter> |