macOS-Simple-KVM/README.md

# macOS-Simple-KVM
Documentation to set up a simple macOS VM in QEMU, accelerated by KVM.

By [@FoxletFox](https://twitter.com/foxletfox), and the help of many others. Find this useful? You can donate [on Coinbase](https://commerce.coinbase.com/checkout/96dc5777-0abf-437d-a9b5-a78ae2c4c227) or [Paypal!](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=QFXXKKAB2B9MA&item_name=macOS-Simple-KVM).

New to macOS and KVM? Check [the FAQs.](docs/FAQs.md)

## Getting Started
You'll need a Linux system with `qemu` (3.1 or later), `python3`, `pip` and the KVM modules enabled. A Mac is **not** required. Some examples for different distributions:

```
sudo apt-get install qemu-system qemu-utils python3 python3-pip  # for Ubuntu, Debian, Mint, and PopOS.
sudo pacman -S qemu python python-pip            # for Arch.
sudo xbps-install -Su qemu python3 python3-pip   # for Void Linux.
sudo zypper in qemu-tools qemu-kvm qemu-x86 qemu-audio-pa python3-pip  # for openSUSE Tumbleweed
sudo dnf install qemu qemu-img python3 python3-pip # for Fedora
```

## Step 1
Run `jumpstart.sh` to download installation media for macOS (internet required). The default installation uses Catalina, but you can choose which version to get by adding either `--high-sierra`, `--mojave`, or `--catalina`. For example:
```
./jumpstart.sh --mojave
```
> Note: You can skip this if you already have `BaseSystem.img` downloaded. If you have `BaseSystem.dmg`, you will need to convert it with the `dmg2img` tool.

## Step 2
Create an empty hard disk using `qemu-img`, changing the name and size to preference:
```
qemu-img create -f qcow2 MyDisk.qcow2 64G
```

and add it to the end of `basic.sh`:
```
    -drive id=SystemDisk,if=none,file=MyDisk.qcow2 \
    -device ide-hd,bus=sata.4,drive=SystemDisk \
```
> Note: If you're running on a headless system (such as on Cloud providers), you will need `-nographic` and `-vnc :0 -k en-us` for VNC support.

Then run `basic.sh` to start the machine and install macOS. Remember to partition in Disk Utility first!

## Step 2a (Virtual Machine Manager)
If instead of QEMU, you'd like to import the setup into Virt-Manager for further configuration, just run `sudo ./make.sh --add`.

## Step 2b (Headless Systems)
If you're using a cloud-based/headless system, you can use `headless.sh` to set up a quick VNC instance. Settings are defined through variables as seen in the following example. VNC will start on port `5900` by default.
```
HEADLESS=1 MEM=1G CPUS=2 SYSTEM_DISK=MyDisk.qcow2 ./headless.sh
```

## Step 3

You're done!

To fine-tune the system and improve performance, look in the `docs` folder for more information on [adding memory](docs/guide-performance.md), setting up [bridged networking](docs/guide-networking.md), adding [passthrough hardware (for GPUs)](docs/guide-passthrough.md), tweaking [screen resolution](docs/guide-screen-resolution.md), and enabling sound features.
Initial commit 2019-04-22 09:25:21 +02:00			`# macOS-Simple-KVM`
[DOCS] Update docs. 2019-04-30 23:48:10 +02:00			`Documentation to set up a simple macOS VM in QEMU, accelerated by KVM.`
Initial documentation. 2019-04-23 00:08:10 +02:00
[DOCS] Update repo funding. 2019-10-30 08:11:31 +01:00			`By [@FoxletFox](https://twitter.com/foxletfox), and the help of many others. Find this useful? You can donate [on Coinbase](https://commerce.coinbase.com/checkout/96dc5777-0abf-437d-a9b5-a78ae2c4c227) or [Paypal!](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=QFXXKKAB2B9MA&item_name=macOS-Simple-KVM).`
[DOCS] Clarify Cloud support, QEMU version. 2019-06-20 00:35:31 +02:00
[DOCS] Add donation, headless docs, minor corrections. 2019-07-05 01:15:55 +02:00			`New to macOS and KVM? Check [the FAQs.](docs/FAQs.md)`
[DOCS] Update sections. 2019-05-11 23:25:09 +02:00
[DOCS] Update README. 2019-05-10 20:07:24 +02:00			`## Getting Started`
[DOCS] Add donation, headless docs, minor corrections. 2019-07-05 01:15:55 +02:00			You'll need a Linux system with `qemu` (3.1 or later), `python3`, `pip` and the KVM modules enabled. A Mac is not required. Some examples for different distributions:
[DOCS] Clarify installation. 2019-06-07 01:53:57 +02:00
			```
[DOCS] Clarify Cloud support, QEMU version. 2019-06-20 00:35:31 +02:00			`sudo apt-get install qemu-system qemu-utils python3 python3-pip # for Ubuntu, Debian, Mint, and PopOS.`
			`sudo pacman -S qemu python python-pip # for Arch.`
			`sudo xbps-install -Su qemu python3 python3-pip # for Void Linux.`
[DOCS] Add donation, headless docs, minor corrections. 2019-07-05 01:15:55 +02:00			`sudo zypper in qemu-tools qemu-kvm qemu-x86 qemu-audio-pa python3-pip # for openSUSE Tumbleweed`
Add example for Fedora 2019-09-25 02:03:51 +02:00			`sudo dnf install qemu qemu-img python3 python3-pip # for Fedora`
[DOCS] Clarify installation. 2019-06-07 01:53:57 +02:00			```
[DOCS] Update README. 2019-04-25 22:57:52 +02:00
Initial documentation. 2019-04-23 00:08:10 +02:00			`## Step 1`
[DOCS] Clarify installation. 2019-06-07 01:53:57 +02:00			Run `jumpstart.sh` to download installation media for macOS (internet required). The default installation uses Catalina, but you can choose which version to get by adding either `--high-sierra`, `--mojave`, or `--catalina`. For example:
			```
			`./jumpstart.sh --mojave`
			```
[DOCS] Fix formatting. 2019-05-11 23:32:56 +02:00			> Note: You can skip this if you already have `BaseSystem.img` downloaded. If you have `BaseSystem.dmg`, you will need to convert it with the `dmg2img` tool.
Initial documentation. 2019-04-23 00:08:10 +02:00
[DOCS] Update docs. 2019-04-30 23:48:10 +02:00			`## Step 2`
[DOCS] Update README. 2019-05-10 20:07:24 +02:00			Create an empty hard disk using `qemu-img`, changing the name and size to preference:
[DOCS] Add instructions to create a disk. 2019-04-24 17:11:50 +02:00			```
			`qemu-img create -f qcow2 MyDisk.qcow2 64G`
			```

[DOCS] Update README. 2019-05-10 20:07:24 +02:00			and add it to the end of `basic.sh`:
[DOCS] Add instructions to create a disk. 2019-04-24 17:11:50 +02:00			```
			`-drive id=SystemDisk,if=none,file=MyDisk.qcow2 \`
			`-device ide-hd,bus=sata.4,drive=SystemDisk \`
			```
[DOCS] Clarify Cloud support, QEMU version. 2019-06-20 00:35:31 +02:00			> Note: If you're running on a headless system (such as on Cloud providers), you will need `-nographic` and `-vnc :0 -k en-us` for VNC support.
[DOCS] Add instructions to create a disk. 2019-04-24 17:11:50 +02:00
[DOCS] Update again. 2019-06-19 22:08:54 +02:00			Then run `basic.sh` to start the machine and install macOS. Remember to partition in Disk Utility first!
Initial documentation. 2019-04-23 00:08:10 +02:00
[DOCS] Update README. 2019-05-10 20:07:24 +02:00			`## Step 2a (Virtual Machine Manager)`
[DOCS] Add donation, headless docs, minor corrections. 2019-07-05 01:15:55 +02:00			If instead of QEMU, you'd like to import the setup into Virt-Manager for further configuration, just run `sudo ./make.sh --add`.

			`## Step 2b (Headless Systems)`
			If you're using a cloud-based/headless system, you can use `headless.sh` to set up a quick VNC instance. Settings are defined through variables as seen in the following example. VNC will start on port `5900` by default.
			```
			`HEADLESS=1 MEM=1G CPUS=2 SYSTEM_DISK=MyDisk.qcow2 ./headless.sh`
			```
[DOCS] Update README. 2019-05-10 20:07:24 +02:00
Initial documentation. 2019-04-23 00:08:10 +02:00			`## Step 3`
[DOCS] Update docs. 2019-04-30 23:48:10 +02:00
			`You're done!`

Add link to screen resolution guide 2019-09-18 12:08:19 +02:00			To fine-tune the system and improve performance, look in the `docs` folder for more information on [adding memory](docs/guide-performance.md), setting up [bridged networking](docs/guide-networking.md), adding [passthrough hardware (for GPUs)](docs/guide-passthrough.md), tweaking [screen resolution](docs/guide-screen-resolution.md), and enabling sound features.