diff --git a/README.md b/README.md index e4e9ee2..bf6de56 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,6 @@ If you like this project, consider contributing here or upstream! ## Quick Start Docker-OSX -Video setup tutorial is also available here: https://www.youtube.com/watch?v=wLezYl77Ll8 - **Windows users:** [click here to see the notes below](#id-like-to-run-docker-osx-on-windows)!
@@ -56,7 +54,18 @@ First time here? try [initial setup](#initial-setup), otherwise try the instruct Release names and their version: -### Catalina (10.15) [](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated) +You can run any version of macOS by changing the `SHORTNAME` environment variable. + +| macOS Version | `SHORTNAME` | +| --- | --- | +| Sequoia (15) | `sequoia` | +| Sonoma (14) | `sonoma` | +| Ventura (13) | `ventura` | +| Monterey (12) | `monterey` | +| Big Sur (11) | `big-sur` | +| Catalina (10.15) | `catalina` | +| Mojave (10.14) | `mojave` | +| High Sierra (10.13) | `high-sierra` | ```bash docker run -it \ @@ -64,96 +73,19 @@ docker run -it \ -p 50922:10022 \ -v /tmp/.X11-unix:/tmp/.X11-unix \ -e "DISPLAY=${DISPLAY:-:0.0}" \ - -e SHORTNAME=catalina \ + -e "SHORTNAME=sequoia" \ sickcodes/docker-osx:latest - -# docker build -t docker-osx . -``` -### Big Sur (11) [](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated) - -```bash -docker run -it \ - --device /dev/kvm \ - -p 50922:10022 \ - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -e "DISPLAY=${DISPLAY:-:0.0}" \ - -e SHORTNAME=big-sur \ - sickcodes/docker-osx:latest - -# docker build -t docker-osx . ``` -### Monterey (12) [](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated) +**Explanation of the command:** -```bash - -docker run -it \ - --device /dev/kvm \ - -p 50922:10022 \ - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -e "DISPLAY=${DISPLAY:-:0.0}" \ - -e GENERATE_UNIQUE=true \ - -e MASTER_PLIST_URL='https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-custom.plist' \ - -e SHORTNAME=monterey \ - sickcodes/docker-osx:latest - -# docker build -t docker-osx . -``` - -### Ventura (13) [](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated) - -```bash - -docker run -it \ - --device /dev/kvm \ - -p 50922:10022 \ - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -e "DISPLAY=${DISPLAY:-:0.0}" \ - -e GENERATE_UNIQUE=true \ - -e MASTER_PLIST_URL='https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-custom.plist' \ - -e SHORTNAME=ventura \ - sickcodes/docker-osx:latest - -# docker build -t docker-osx . -``` - -### Sonoma (14) [](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated) - -```bash - -docker run -it \ - --device /dev/kvm \ - -p 50922:10022 \ - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -e "DISPLAY=${DISPLAY:-:0.0}" \ - -e GENERATE_UNIQUE=true \ - -e CPU='Haswell-noTSX' \ - -e CPUID_FLAGS='kvm=on,vendor=GenuineIntel,+invtsc,vmware-cpuid-freq=on' \ - -e MASTER_PLIST_URL='https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-custom-sonoma.plist' \ - -e SHORTNAME=sonoma \ - sickcodes/docker-osx:latest - -# docker build -t docker-osx . -``` - -### Sequoia (15) [](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated) - -```bash - -docker run -it \ - --device /dev/kvm \ - -p 50922:10022 \ - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -e "DISPLAY=${DISPLAY:-:0.0}" \ - -e GENERATE_UNIQUE=true \ - -e CPU='Haswell-noTSX' \ - -e CPUID_FLAGS='kvm=on,vendor=GenuineIntel,+invtsc,vmware-cpuid-freq=on' \ - -e MASTER_PLIST_URL='https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-custom-sonoma.plist' \ - -e SHORTNAME=sequoia \ - sickcodes/docker-osx:latest - -# docker build -t docker-osx . -``` +* `docker run -it`: This command runs a Docker container in interactive mode. +* `--device /dev/kvm`: This flag gives the container access to the KVM for hardware acceleration. +* `-p 50922:10022`: This flag maps port `10022` in the container to port `50922` on the host. This is used for SSH access. +* `-v /tmp/.X11-unix:/tmp/.X11-unix`: This flag mounts the X11 socket from the host to the container. This is used for GUI forwarding. +* `-e "DISPLAY=${DISPLAY:-:0.0}"`: This flag sets the `DISPLAY` environment variable in the container. This is also used for GUI forwarding. +* `-e "SHORTNAME=sequoia"`: This flag sets the `SHORTNAME` environment variable in the container. This determines which version of macOS to download and install. +* `sickcodes/docker-osx:latest`: This is the name of the Docker image to use.