Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Metamogul authored Aug 31, 2024
1 parent 6324aa7 commit 9b6b1be
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# UTM Snapshot Manager

This is a companion app for the popular MacOS virtual machine host [UTM](https://github.com/utmapp/UTM) to manage snapshots for existing virtual machines. UTM itself doesn't give access to that functionality so far; however the QEMU hypervisor which UTM leverages per default, offers [snapshot management](https://kashyapc.fedorapeople.org/virt/lc-2012/snapshots-handout.html). This project is intended as proof-of-concept for that functionality and not as a releasable product – especially it doesn't support taking live snapshots, supports only the default QEMU hypervisor and doesn't come with a precompiled release binary (since I don't have a paid Apple Developer subscription to create an app package signed for distribution). However it should be perfectly possible to just download and compile it out of the box.
This is a companion app for the popular MacOS virtual machine host [UTM](https://github.com/utmapp/UTM) to manage snapshots for existing virtual machines. UTM itself doesn't give access to that functionality so far; however the QEMU hypervisor which UTM leverages per default, offers [snapshot management](https://kashyapc.fedorapeople.org/virt/lc-2012/snapshots-handout.html) for `.qcow` formatted disks. This project is intended as proof-of-concept for that functionality and not as a releasable product – especially it doesn't support taking live snapshots, supports only the default QEMU hypervisor and doesn't come with a precompiled release binary (since I don't have a paid Apple Developer subscription to create an app package signed for distribution). However it should be perfectly possible to just download and compile it out of the box.

![UTM Snapshot Manager - Screenshot of the main window with navigation pane on the left and details view with VMs on the right](https://github.com/Metamogul/UTM-Snapshot-Manager/blob/main/Screenshot.png)

Expand All @@ -14,9 +14,9 @@ For it's functionality the app depends on `qemu-img` – it's basically a nice U

## Usage ##

Use the navigation pane on the right to manage groups of VMs. A group can also just contain one virtual machine. With a group selected, virtual machines can be added via the ➕ icon in the navigation area. Every virtual machine in a group will display a list of it's snapshots or a placeholder if there are none. Use the ➕, ➖ and 🔄 icons in the central toolbar area to create, delete or restore a snapshot of the disks for every VM in the group. Open a context menu in an empty space at the bottom of a snapshot list to add a snapshot to just that single virtual machine's disk. Select a snapshot in a list and open a context menu to restore or delete just that particular snapshot.
Use the navigation pane on the right to manage groups of VMs. A group can also just contain one virtual machine. With a group selected, virtual machines can be added via the ➕ icon in the navigation area. Every virtual machine in a group will display a list of it's snapshots or a placeholder if there are none. Use the ➕, ➖ and 🔄 icons in the central toolbar area to create, delete or restore a snapshot of the `.qcow` disks for every VM in the group. Open a context menu in an empty space at the bottom of a snapshot list to add a snapshot to just that single virtual machine's disk. Select a snapshot in a list and open a context menu to restore or delete just that particular snapshot.

**Warning**: Please keep in mind that the snapshot creation operates only on the disk files of the VMs. Don't use it on live VMs, because there's a very high risk of ending up with a corrupted file system due to uncommitted changes, unwritten caches etc.
**Warning**: Please keep in mind that the snapshot creation operates only on `.qcow` disk files of the VMs. Don't use it on live VMs, because there's a very high risk of ending up with a corrupted file system due to uncommitted changes, unwritten caches etc.

## Known issues ##

Expand Down

0 comments on commit 9b6b1be

Please sign in to comment.