Verified Commit 060ef692 authored by Marin Hannache's avatar Marin Hannache
Browse files

vm: add documentation for common issues


Signed-off-by: Marin Hannache's avatarMarin Hannache <mareo@cri.epita.fr>
parent 0c2799c9
......@@ -3,14 +3,17 @@
This method allow you to have the PIE environment running in a VM on your
computer.
## First step
## Installation
### First step
Install [Virtual Box](https://www.virtualbox.org/).
On linux you can install it with your packet manager ([Debian](https://wiki.debian.org/VirtualBox) or
On linux you can install it with your packet manager
([Debian](https://wiki.debian.org/VirtualBox) or
[ArchLinux](https://wiki.archlinux.org/index.php/VirtualBox)).
## Second step
### Second step
Download our [VirtualBox appliance](https://static.cri.epita.fr/cri-vm.ova).
......@@ -31,22 +34,22 @@ You can then click the `Import` button.
![settings](assets/vm_external_4.PNG)
## Third step
### Third step
Inside Virtual Box select your newly created virtual machine and click on
`Start` button.
the `Start` button.
![select](assets/vm_external_5.PNG)
In the familiar PXE menu, choose the `Prepare disk` entry.
Let it boot, a script will run automatically and your VM will shutdown once its
done.
![select](assets/vm_external_5.PNG)
![menu](assets/vm_external_6.PNG)
## Fourth step
### Fourth step
You can now `Start` your VM again. You can now use the PXE menu as usual to
boot `Archlinux` image.
......@@ -54,3 +57,35 @@ boot `Archlinux` image.
Be careful ! You should log with `epita` user and no password. Your data is in
`/home/epita`, this directory is kept between reboot, you will not lose files
each time you stop your VM.
### Fifth step (optional)
You can restore your files by using the `afs-restore` command in a terminal.
## Common issues
### Error: failed to start Switch Root.
![error-switch-root](assets/vm_error_switch_root.png)
You probably didn't start the `Prepare disk` image, please do the third step
again.
### Black screen after starting the VM
Please ensure you are using VirtualBox 6.1 (you can check in
`Help -> About VirtualBox`).
### Not in a hypervisor partition
![virt-disabled](assets/vm_error_virt_disabled.png)
You need to enable Vt-x or AMD-V in your BIOS.
### Cannot enable nested VT-x/AMD-V without nested-paging
![nested](assets/vm_error_nested.png)
Go to the VM settings window and in the `System` page and `Processor` tab,
uncheck the `Enable nested Vt-x/AMD-V` box.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment