Differences

This shows you the differences between two versions of the page.

--- docs:guide-user:virtualization:virtualbox-vm [2019/06/04 22:39] – [Prerequisites] bbmian
+++ docs:guide-user:virtualization:virtualbox-vm [2023/10/20 01:46] (current) – [VM setup] atownlede
@@ Line 1: / Line 1: @@
-====== Run OpenWrt as a VirtualBox virtual machine ======
+====== OpenWrt on VirtualBox HowTo ======
-This document describes how to run the x86-64 OpenWrt images in [[https://www.virtualbox.org|VirtualBox]], or VB for short.
+This document describes how to run the x86-64 OpenWrt images in <abbr>Virtual Machine (VM)</abbr> [[https://www.virtualbox.org|VirtualBox]], or VBox for short.
 ===== Prerequisites =====
   * Download and install [[https://www.virtualbox.org/wiki/Downloads|VirtualBox]]
   * Download and install the VirtualBox Guest Additions (needed for USB connectivity among others)
-  * Download the //openwrt-x86-64-combined-squashfs.img.gz// image, from [[https://downloads.openwrt.org/snapshots/targets/x86/64/|snapshots/targets/x86/64/]] (On Linux, download the //openwrt-x86-64-combined-ext4.img.gz// image)
-  * Uncompress the gziped img file. On Linux use the command ''gzip -d openwrt-x86-64-combined-ext4.img.gz''
-  * Open a terminal and go in the folder where you have downloaded the file (sorry, the tool has only a command line interface)
-  * Convert it to native VB format by writing this in command line (the same for Windows, Mac and Linux. Sadly this tool does not have graphical user interface): ''VBoxManage convertfromraw %%--%%format VDI openwrt-x86-64-combined-squashfs.img openwrt-x86-64-combined-squashfs.vdi''
-=== Custom Images ===
+==== Select an OpenWrt image ====
+You need a [[docs:guide-user:installation:openwrt_x86|x86 64 bit version of OpenWrt]].
+There is two versions of them:
+  * ''combined-squashfs.img.gz'' This disk image uses the traditional OpenWrt layout, a squashfs read-only root filesystem and a read-write partition where settings and packages you install are stored. Due to how this image is assembled, you will have only 230-ish MB of space to store additional packages and configuration, and Extroot does not work.
+  * ''combined-ext4.img.gz'' This disk image uses a single read-write ext4 partition with no read-only squashfs root filesystem, which allows to enlarge the partition. Features like Failsafe Mode or Factory Reset won't be available as they need a read-only squashfs partition to function.
+In the guide we'll use //openwrt-x86-64-combined-ext4.img.gz// because it has fewer limitations.
+  * Download a stable release of the //openwrt-x86-64-combined-ext4.img.gz// image from [[https://archive.openwrt.org/releases/|targets/x86/64/ folder]] e.g. [[https://archive.openwrt.org/releases/22.03.5/targets/x86/64/openwrt-22.03.5-x86-64-generic-ext4-combined.img.gz|22.03.5]]. Or you can try the fresher but unstable [[https://downloads.openwrt.org/snapshots/targets/x86/64/openwrt-x86-64-generic-ext4-combined.img.gz|snapshot]] image
+  * Uncompress the gziped img file. On Linux use the command ''gzip -d openwrt-*.img.gz''. As a result you should get the raw ''openwrt-x86-64-combined-ext4.img'' image  file.
+=== Custom Images ===
 You can compile your own image (//Target System -> x86-64// and //Target Images -> Build VirtualBox image files//). ''ext4'' needs to be enabled first.
+==== Convert openwrt.img to VBox drive ====
+  * Open a terminal and go in the folder where you have downloaded the file (sorry, the tool has only a command line interface)
+  * Convert it to native VBox format by writing this in command line (the same for Windows, macOS and Linux. Sadly this tool does not have graphical user interface): ''VBoxManage convertfromraw %%--%%format VDI openwrt-*.img openwrt.vdi''. This will create the ''openwrt.vdi'' file which a virtual drive for VBox virtual machine.
 === Error ===
-if you receive an error similar to\\
+If you receive an error similar to\\
 <code>VBoxManage: error: VD: The given disk size 19444018 is not aligned on a sector boundary (512 bytes)
 VBoxManage: error: Error code VERR_VD_INVALID_SIZE at /Users/vbox/tinderbox/5.1-mac-rel/src/VBox/Storage/VD.cpp(7002) in function int VDCreateBase(PVBOXHDD, const char *, const char *, uint64_t, unsigned int, const char *, PCVDGEOMETRY, PCVDGEOMETRY, PCRTUUID, unsigned int, PVDINTERFACE, PVDINTERFACE)
 VBoxManage: error: Cannot create the disk image "openwrt.vdi": VERR_VD_INVALID_SIZE</code>\\
-you may need to pad the image with ''dd if=openwrt-x86-64-combined-squashfs.img of=openwrt.img bs=128000 conv=sync'' and use the padded image as input to VBoxManage convertfromraw.
+you may need to pad the image with ''dd if=openwrt-x86-64-combined-ext4.img of=openwrt.img bs=128000 conv=sync'' and use the padded image as input to VBoxManage convertfromraw.
   * Enlarge the image to a useful size (size is in MB)
-  $ VboxManage modifymedium openwrt-x86-64-combined-squashfs.vdi --resize 128
+  $ VBoxManage modifymedium openwrt.vdi --resize 128
 %...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
 ===== VM Setup in VirtualBox =====
 ==== VM creation ====
 :!: Tutorial and screenshots from VirtualBox 5.1.8 on Linux host, on Windows or macOS hosts there will be some cosmetic differences (a different top bar) but the VirtualBox panels and buttons will be exactly the same
@@ Line 40: / Line 47: @@
 {{docs:guide-user:vboxaddvm2.png?direct&70 |}} OpenWrt will work fine with much less RAM than the recommended amount, 128 MiB will be enough.
 ----
-{{docs:guide-user:vboxaddvm3.png?direct&70 |}} Choose //Use an existing hard disk file//, click the //file// icon to open //Virtual Media Manager//, click //Add// and choose your ''.vdi'' file using the file chooser window. Click //Create// to end this guided procedure.\\
+{{docs:guide-user:vboxaddvm3.png?direct&70 |}} Choose //Use an existing hard disk file//, click the //file// icon to open //Virtual Media Manager//, click //Add// and choose your ''openwrt.vdi'' file using the file chooser window. Click //Create// to end this guided procedure.\\
 ----
-:!: It's recommended to place the disk image in a permanent place //before// linking it with VB. If you move it //afterwards//, VB will not find it anymore and will complain about this issue on next start (or when you try to start the VM). It will offer a guided procedure to link the disk image again, so don't worry.
+:!: It's recommended to place the disk image in a permanent place //before// linking it with VBox. If you move it //afterwards//, VBox will not find it anymore and will complain about this issue on next start (or when you try to start the VM). It will offer a guided procedure to link the disk image again, so don't worry.
 ==== VM setup ====
+{{section>meta:infobox:howto_links#config-network-device&noheader&nofooter&noeditbutton}}
 This part of the configuration will deal with setting up networking manually.\\
 The configuration you will set up by following this tutorial is:
@@ Line 58: / Line 67: @@
 == Host-only network adapter ==
 we first need to make sure there is a Host-only network adapter and that it has the right settings\\
-Note: this is found in VB 6.0 (at least for Windows) under Tools, and is pre-configured.
+Note: this is found in VBox 6.0 (at least for Windows) under Tools, and is pre-configured.
 ----
 {{docs:guide-user:vboxvmhost-only-network1.png?direct&70 |}} Click on **File** -> **Preferences** -> **Network**\\
@@ Line 126: / Line 135: @@
     - **reboot**
   - Now your VM should be accessible from SSH, user **root** (no password) address **192.168.56.2**
-  - After you have logged in successfully, we can actually do the true configuration, please copy-paste the following block of code and press enter:\\ <code>uci batch <<EOF
+  - After you have logged in successfully, we can actually do the true configuration. For 22.03 and earlier, copy-paste the following block of code and press enter:\\ <code>uci batch <<EOF
 set network.mng=interface
 set network.mng.type='bridge'
@@ Line 137: / Line 146: @@
 set network.wan=interface
 set network.wan.ifname='eth1'
+set network.wan.proto='dhcp'
+EOF</code>  For 23.05 and later, copy-paste the following:\\ <code>uci batch <<EOF
+set network.mng=interface
+set network.mng.device='br-lan'
+set network.mng.proto='static'
+set network.mng.ipaddr='192.168.56.2'
+set network.mng.netmask='255.255.255.0'
+set firewall.@zone[0].network='mng'
+set firewall.@zone[0].name='mng'
+delete network.lan
+delete network.wan6
+set network.wan=interface
+set network.wan.device='eth1'
 set network.wan.proto='dhcp'
 EOF</code>
-  - now write **uci changes** to check if the setting configuration was loaded correctly. If you see the following (the **network.mng** entries MUST be the same as the ones shown here, the **network.wan** might be slightly different), everything went well\\ <code>root@openwrt:~# uci changes
+  - now write **uci changes** to check if the setting configuration was loaded correctly. If you see the following on 22.03 and earlier (the **network.mng** entries MUST be the same as the ones shown here, the **network.wan** might be slightly different), everything went well\\ <code>root@openwrt:~# uci changes
 network.mng='interface'
 network.mng.type='bridge'
@@ Line 148: / Line 170: @@
 -network.lan
 -network.wan6
-network.wan='interface'</code>
+network.wan='interface'</code> For 23.03 and later, you should see\\ <code>root@OpenWrt:~# uci changes
+firewall.cfg02dc81.network='mng'
+firewall.cfg02dc81.name='mng'
+network.mng='interface'
+network.mng.device='br-lan'
+network.mng.proto='static'
+network.mng.ipaddr='192.168.56.2'
+network.mng.netmask='255.255.255.0'
+-network.lan
+-network.wan6
+</code>
   - if all is well, save config with **uci commit && reboot**, if all is NOT well, write **reboot** to erase the temporary changes and find a way to set the above configuration manually.
   - close and open again the SSH terminal when the VM has restarted, with same connection parameters (user **root** and **192.168.56.2**)
   - now you should have both internet access (try a **opkg update**) AND a management interface with a static address you can connect your SSH client program to even if your PC is disconnected from a local network.
-  - the optional **Bridged Adapter** on **Adapter 3** isn't crucial for basic functionality and is also specific for your own local network parameters. In my own network (and in most home networks) it will work fine if you write <code>uci batch <<EOF
+  - the optional **Bridged Adapter** on **Adapter 3** isn't crucial for basic functionality and is also specific for your own local network parameters. In my own network (and in most home networks) it will work fine for 22.03 and earlier if you write <code>uci batch <<EOF
 set network.lan=interface
 set network.lan.ifname='eth2'
 set network.lan.proto='dhcp'
 EOF
-uci commit</code>\\ If you have more complex requirements you will have to set that up on your own by reading the documentation, or through luci.
+uci commit</code>and for 23.05 and later <code>uci batch <<EOF
+set network.lan=interface
+set network.lan.device='eth2'
+set network.lan.proto='dhcp'
+EOF
+uci commit
+service network restart
+</code>\\ If you have more complex requirements you will have to set that up on your own by reading the documentation, or through luci.
   - you can now install packages to this images as normal, you will probably want to install luci, write **opkg update && opkg install luci**, then you can connect to the VM's luci by typing 192.168.56.2 in your browser address bar or [[http://192.168.56.2|click on this link]] to get there.
@@ Line 175: / Line 214: @@
 ===== Run with VirtualBox automatically on Start of Windows OS =====
   * Ordered List ItemImport the following entry to your registry or add it manually:
     - [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Run]
@@ Line 191: / Line 229: @@
   * Or use following:
-       - VB Service: https://sourceforge.net/projects/vboxvmservice/
+       - [[https://github.com/onlyfang/VBoxVmService|VBoxVmService]] Windows Service to run VirtualBox VMs automatically
+===== See also =====
+  * [[docs:guide-user:virtualization:virtualbox-advanced|VirtualBox Advanced]]
+  * [[docs:guide-user:virtualization:start|Other virtualization options]]: Docker, VMware etc.