2020-03-17 01:52:46 +00:00
< h1 align = "center" >
< img src = ".github/logo.png" alt = "Quickemu" / >
< br / >
Quickemu
< / h1 >
2020-03-19 21:24:07 +00:00
< p align = "center" > < b > Simple shell script to "manage" Qemu virtual machines.< / b > < / p >
2020-03-17 01:52:46 +00:00
< div align = "center" > < img src = ".github/screenshot.png" alt = "Quickemu Screenshot" / > < / div >
< p align = "center" > Made with 💝 for < img src = "https://raw.githubusercontent.com/anythingcodes/slack-emoji-for-techies/gh-pages/emoji/tux.png" align = "top" width = "24" / > < / p >
## Introduction
2020-03-19 21:24:07 +00:00
Quickemu is a very simple script to "manage" Qemu virtual machines. Each
virtual machine configuration is broadly the same requiring minimal setup. The
main objective of the project is to enable quick testing of desktop Linux
distributions where the virtual machines can be stored anywhere, such as
external USB storage.
2020-03-17 01:52:46 +00:00
2020-03-19 21:24:07 +00:00
Quickemu is opinionated and will attempt to *"do the right thing"* rather than
2020-03-20 01:49:43 +00:00
expose rich configuration options. Quickemu is a frontend to the fully
accelerated [qemu-virgil ](https://snapcraft.io/qemu-virgil ). See the video
where I explain some of my motivations for creating this script.
2020-03-17 01:52:46 +00:00
[](https://www.youtube.com/watch?v=AOTYWEgw0hI)
## Installation
2020-03-20 01:49:43 +00:00
Clone this repository:
2020-03-17 01:52:46 +00:00
```
2020-03-20 01:49:43 +00:00
git clone https://github.com/wimpysworld/quickemu.git
2020-03-17 01:52:46 +00:00
```
2020-03-20 01:49:43 +00:00
Install the `qemu-virgil` snap. You can find details about how to install snapd
and `qemu-virgil` on the [Snap Store page for qemu-virgil ](https://snapcraft.io/qemu-virgil )
2020-03-17 01:52:46 +00:00
```bash
snap install qemu-virgil
2020-03-19 01:49:17 +00:00
snap connect qemu-virgil:kvm
2020-03-17 01:52:46 +00:00
snap connect qemu-virgil:removable-media
```
## Usage
* Download a .iso image of a Linux distribution
* Create a VM configuration file; for example `ubuntu.conf`
```
iso="/media/$USER/Quickemu/ubuntu/focal-desktop-amd64.iso"
disk_img="/media/$USER/Quickemu/ubuntu/focal-desktop-amd64.qcow2
2020-03-19 02:06:55 +00:00
disk=128G
2020-03-17 01:52:46 +00:00
```
2020-03-20 13:53:42 +00:00
* Use `quickemu` to start the virtual machine:
2020-03-17 01:52:46 +00:00
```
./quickemu --vm ubuntu-focal-desktop.conf
```
2020-03-19 21:24:07 +00:00
Which will output something like this:
```
Starting /media/martin/Quickemu/ubuntu-focal-desktop.conf
2020-03-20 01:49:43 +00:00
- QEMU: /snap/bin/qemu-virgil v4.2.0
2020-03-19 21:24:07 +00:00
- BIOS: Legacy
2020-03-20 01:49:43 +00:00
- Disk: /media/martin/Quickemu/ubuntu/focal-desktop-amd64.qcow2 (64G)
2020-03-19 21:24:07 +00:00
- ISO: /media/martin/Quickemu/ubuntu/focal-desktop-amd64.iso
- CPU: 4 Core(s)
- RAM: 4G
- UI: sdl
- GL: on
- VIRGL: on
2020-03-20 01:49:43 +00:00
- Display: 1664x936
2020-03-19 21:24:07 +00:00
- smbd: /home/martin will be exported to the guest via smb://10.0.2.4/qemu
- ssh: 22221/tcp is connected. Login via 'ssh user@localhost -p 22221'
```
2020-03-17 01:52:46 +00:00
Here are the full usage instructions:
```
Usage
quickemu --vm ubuntu.conf
You can also pass optional parameters
--delete : Delete the disk image.
2020-03-20 13:50:01 +00:00
--efi : Enable EFI BIOS.
2020-03-17 01:52:46 +00:00
--restore : Restore the snapshot.
--snapshot : Create a disk snapshot.
```
## TODO
2020-03-19 02:06:55 +00:00
- [x] Make display configuration more robust
2020-03-19 03:07:52 +00:00
- [x] Improve stdout presentation
2020-03-19 02:14:52 +00:00
- [x] Make disk image optionally size configurable
2020-03-20 01:49:43 +00:00
- [ ] Improve snapshot management
2020-03-20 13:46:18 +00:00
- [ ] Create desktop launcher for a VM
2020-03-20 13:50:01 +00:00
- [x] Fix Virgil 3D on EFI boot
2020-03-20 13:46:18 +00:00
- [x] Get QEMU `-audiodev` working for audio input, something like:
