From ad126cd4dfb404b6b8ef0deb1cec9a3bae837f84 Mon Sep 17 00:00:00 2001 From: Foxlet Date: Wed, 19 Jun 2019 18:35:31 -0400 Subject: [PATCH] [DOCS] Clarify Cloud support, QEMU version. --- README.md | 17 +++++++++-------- docs/FAQs.md | 6 ++++++ 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 982076f..9048901 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,17 @@ # 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 here!](https://commerce.coinbase.com/checkout/96dc5777-0abf-437d-a9b5-a78ae2c4c227) +By [@FoxletFox](https://twitter.com/foxletfox), and the help of many others. Find this useful? [You can donate here!](https://commerce.coinbase.com/checkout/96dc5777-0abf-437d-a9b5-a78ae2c4c227) + +New to macOS KVM? Check [the FAQs.](docs/FAQs.md) ## Getting Started -You'll need a Linux system with `qemu`, `python3`, `pip` and the KVM extensions installed for this project. A Mac is **not** required. Some examples for different distributions: +You'll need a Linux system with `qemu` (3.1 or later), `python3`, `pip` and the KVM extensions installed for this project. 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 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. ``` ## Step 1 @@ -31,7 +32,7 @@ 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 set up `-vnc` to use it. +> 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! @@ -42,4 +43,4 @@ If instead of QEMU, you'd like to import the setup into Virt-Manager for further 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), seting up [bridged networking](docs/guide-networking.md), adding [passthrough hardware (for GPUs)](docs/guide-passthrough.md), and enabling sound features. +To fine-tune the system and improve performance, look in the `docs` folder for more information on [adding memory](docs/guide-performance.md), seting up [bridged networking](docs/guide-networking.md), adding [passthrough hardware (for GPUs)](docs/guide-passthrough.md), and enabling sound features. \ No newline at end of file diff --git a/docs/FAQs.md b/docs/FAQs.md index cfed4fd..3d95e8e 100644 --- a/docs/FAQs.md +++ b/docs/FAQs.md @@ -2,3 +2,9 @@ ## Q: How much disk space do I need? A: The jumpstart download is ~500MB compressed (2GB uncompressed), the installation files are uncompressed and measure 6.5GB. Bare minimum virtual disk size would be around 20GB, but you'll find it hard to get any apps installed (like Xcode, which is at least 8GB compressed). + +## Q: Does this work on DigitalOcean/ScaleWay/Azure/GCS? +A: If the cloud providers supports KVM as well as the necessary CPU instructions, yes. + In some cases only certain tiers work on some providers as the CPUs need to be supported. + + For DigitalOcean, this means a `General Purpose` or `CPU Optimized` machine is required. `Ubuntu 19.04` or newer is recommended. \ No newline at end of file