control-vm/README.adoc

= control-vm.sh
:toc:

This repository contains a simple bash script to start and stop virtual machines run by QEMU and KVM and to connect to them via SSH or VNC or SPICE.

The newest version can be probably found on https://git.holgersson.xyz/nfr/control-vm.

NOTE: While the author already runs this software in "production" on his private setup he would still conside some parts as beta quality. As usual it's strongly recommended to create backups first and read through the bash script to understand roughly what it does.

== Installation
Please install the following tools which are used by the script:

- bash
- >=qemu-6.0.0 
- socat
- remote-viewer as part of virt-viewer (https://virt-manager.org)
 
== Usage
[source, shell]
----
./control-vm.sh <name of your virtual machine> start | shutdown | stop | connect | save | restore | pause | resume"
----

NOTE: You do not see any 'setup' command there as I've implemented no one-shot boot from ISO so far.

== Contact
If you have questions, suggestions or want to brag about your other qemu managing tools feel free to write an email or conact via IRC or mastodon:

  - mail: `nils@holgersson.xyz`
  - IRC: `holgersson` on libera.chat and oftc, mostly in Gentoo related channels
  - mastodon: `https://maly.io/@holgersson`

== Copyright
The bash script and it's documentation (this README) are licensed as MIT, copyright by Nils Freydank.

The used software has each is own license, but is all FLOSS software.

// vim:syntax=asciidoc:fileencoding=utf-8:ts=4:expandtab:linebreak:wrap
README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc 2024-05-05 18:28:43 +02:00			`= control-vm.sh`
			`:toc:`

README.adoc: Update formatting, fix typos 2024-06-23 11:59:43 +02:00			`This repository contains a simple bash script to start and stop virtual machines run by QEMU and KVM and to connect to them via SSH or VNC or SPICE.`
Initial commit 2021-09-30 11:49:37 +02:00
README.adoc: Update formatting, fix typos 2024-06-23 11:59:43 +02:00			`The newest version can be probably found on https://git.holgersson.xyz/nfr/control-vm.`
Initial commit 2021-09-30 11:49:37 +02:00
README.adoc: Update formatting, fix typos 2024-06-23 11:59:43 +02:00			`NOTE: While the author already runs this software in "production" on his private setup he would still conside some parts as beta quality. As usual it's strongly recommended to create backups first and read through the bash script to understand roughly what it does.`
Initial commit 2021-09-30 11:49:37 +02:00
README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc 2024-05-05 18:28:43 +02:00			`== Installation`
Initial commit 2021-09-30 11:49:37 +02:00			`Please install the following tools which are used by the script:`

			`- bash`
			`- >=qemu-6.0.0`
			`- socat`
README.txt: Mention the correct SPICE client 2021-09-30 19:25:03 +02:00			`- remote-viewer as part of virt-viewer (https://virt-manager.org)`
Initial commit 2021-09-30 11:49:37 +02:00
README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc 2024-05-05 18:28:43 +02:00			`== Usage`
			`[source, shell]`
			`----`
Initial commit 2021-09-30 11:49:37 +02:00			`./control-vm.sh <name of your virtual machine> start \| shutdown \| stop \| connect \| save \| restore \| pause \| resume"`
README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc 2024-05-05 18:28:43 +02:00			`----`
Initial commit 2021-09-30 11:49:37 +02:00
README.adoc: Update formatting, fix typos 2024-06-23 11:59:43 +02:00			`NOTE: You do not see any 'setup' command there as I've implemented no one-shot boot from ISO so far.`
Initial commit 2021-09-30 11:49:37 +02:00
README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc 2024-05-05 18:28:43 +02:00			`== Contact`
README.adoc: Add mastodon handle to contact section, reformat 2024-06-23 11:59:43 +02:00			`If you have questions, suggestions or want to brag about your other qemu managing tools feel free to write an email or conact via IRC or mastodon:`
README.adoc: Update formatting, fix typos 2024-06-23 11:59:43 +02:00
README.adoc: Add mastodon handle to contact section, reformat 2024-06-23 11:59:43 +02:00			- mail: `nils@holgersson.xyz`
			- IRC: `holgersson` on libera.chat and oftc, mostly in Gentoo related channels
			- mastodon: `https://maly.io/@holgersson`
Initial commit 2021-09-30 11:49:37 +02:00
README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc 2024-05-05 18:28:43 +02:00			`== Copyright`
README.adoc: Update formatting, fix typos 2024-06-23 11:59:43 +02:00			`The bash script and it's documentation (this README) are licensed as MIT, copyright by Nils Freydank.`
Initial commit 2021-09-30 11:49:37 +02:00
			`The used software has each is own license, but is all FLOSS software.`
README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc 2024-05-05 18:28:43 +02:00
			`// vim:syntax=asciidoc:fileencoding=utf-8:ts=4:expandtab:linebreak:wrap`