aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorsickcodes <[email protected]>2021-08-25 23:05:17 +0000
committersickcodes <[email protected]>2021-08-25 23:05:17 +0000
commit61012cf0c8d92127e93ddc347e988c5c2b1cf5e6 (patch)
treec4a4ab126df5fc0b848cec039c0e1dfc7fae9322 /README.md
parentAdd Discord server for general enquiries (diff)
downloaddocker-osx-61012cf0c8d92127e93ddc347e988c5c2b1cf5e6.tar.xz
docker-osx-61012cf0c8d92127e93ddc347e988c5c2b1cf5e6.zip
Add new image `docker pull sickcodes/docker-osx:naked-auto`. Also allow -e USERNAME -e PASSWORD for auto, even though it's 20GB.
Diffstat (limited to 'README.md')
-rw-r--r--README.md118
1 files changed, 88 insertions, 30 deletions
diff --git a/README.md b/README.md
index 76bfa58..c3a0ba9 100644
--- a/README.md
+++ b/README.md
@@ -53,6 +53,65 @@ docker run -it \
sickcodes/docker-osx:big-sur
```
+#### Run Catalina Pre-Installed [![https://img.shields.io/docker/image-size/sickcodes/docker-osx/auto?label=sickcodes%2Fdocker-osx%3Aauto](https://img.shields.io/docker/image-size/sickcodes/docker-osx/auto?label=sickcodes%2Fdocker-osx%3Aauto)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated)
+
+```bash
+# 40GB disk space required: 20GB original image 20GB your container.
+docker pull sickcodes/docker-osx:auto
+
+# boot directly into a real OS X shell with a visual display [NOT HEADLESS]
+docker run -it \
+ --device /dev/kvm \
+ -p 50922:10022 \
+ -v /tmp/.X11-unix:/tmp/.X11-unix \
+ -e "DISPLAY=${DISPLAY:-:0.0}" \
+ sickcodes/docker-osx:auto
+
+# username is user
+# passsword is alpine
+```
+
+#### Download the image manually and use it in Docker
+
+[![https://img.shields.io/docker/image-size/sickcodes/docker-osx/naked?label=sickcodes%2Fdocker-osx%3Anaked](https://img.shields.io/docker/image-size/sickcodes/docker-osx/naked?label=sickcodes%2Fdocker-osx%3Anaked)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated)
+
+
+This is a particularly good way for downloading the container, in case Docker's CDN (or your connection) happens to be slow.
+
+```bash
+wget https://images2.sick.codes/mac_hdd_ng_auto.img
+
+docker run -it \
+ --device /dev/kvm \
+ -p 50922:10022 \
+ -v "${PWD}/mac_hdd_ng_auto.img:/image" \
+ -v /tmp/.X11-unix:/tmp/.X11-unix \
+ -e "DISPLAY=${DISPLAY:-:0.0}" \
+ sickcodes/docker-osx:naked
+```
+
+
+#### Use your own image and manually and automatically log into a shell
+
+[![https://img.shields.io/docker/image-size/sickcodes/docker-osx/naked-auto?label=sickcodes%2Fdocker-osx%3Anaked-auto](https://img.shields.io/docker/image-size/sickcodes/docker-osx/naked-auto?label=sickcodes%2Fdocker-osx%3Anaked-auto)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated)
+
+
+Enable SSH in network sharing inside the guest first. Change `-e "USERNAME=user"` and `-e "USERNAME=password"` to your credentials. The container will add itself to `~/.ssh/authorized_keys`
+
+```bash
+wget https://images2.sick.codes/mac_hdd_ng_auto.img
+
+docker run -it \
+ --device /dev/kvm \
+ -p 50922:10022 \
+ -v "${PWD}/mac_hdd_ng_auto.img:/image" \
+ -v /tmp/.X11-unix:/tmp/.X11-unix \
+ -e "DISPLAY=${DISPLAY:-:0.0}" \
+ -e "USERNAME=user" \
+ -e "DISPLAY=alpine" \
+ sickcodes/docker-osx:naked-auto
+```
+
## Make container FASTER
SEE commands in [https://github.com/sickcodes/osx-optimizer](https://github.com/sickcodes/osx-optimizer)!
@@ -68,7 +127,13 @@ SEE commands in [https://github.com/sickcodes/osx-optimizer](https://github.com/
## Technical details
-There currently four images, each with different use cases (explained [below](#container-images)):
+There currently five images, each with different use cases (explained [below](#container-images)):
+
+- Catalina
+- Big Sur
+- Auto (pre-made Catalina)
+- Naked (use your own .img)
+- Naked-Auto (user your own .img and SSH in)
Catalina make your own image:
@@ -86,6 +151,10 @@ Bring-your-own-image setup (use any of the above first):
[![https://img.shields.io/docker/image-size/sickcodes/docker-osx/naked?label=sickcodes%2Fdocker-osx%3Anaked](https://img.shields.io/docker/image-size/sickcodes/docker-osx/naked?label=sickcodes%2Fdocker-osx%3Anaked)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated)
+Same as above but with `-e USERNAME` & `-e PASSWORD` and `-e OSX_COMMANDS="put your commands here"`
+
+[![https://img.shields.io/docker/image-size/sickcodes/docker-osx/naked-auto?label=sickcodes%2Fdocker-osx%3Anaked-auto](https://img.shields.io/docker/image-size/sickcodes/docker-osx/naked-auto?label=sickcodes%2Fdocker-osx%3Anaked-auto)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated)
+
## Capabilities
- SSH enabled (`localhost:50922`)
- VNC enabled (`localhost:8888`) if using ./vnc version
@@ -1106,31 +1175,34 @@ The Quick Start command should work out of the box, provided that you keep the f
-e "DISPLAY=${DISPLAY:-:0.0}" \
```
-#### Download the image manually and use it in Docker
-
-[![https://img.shields.io/docker/image-size/sickcodes/docker-osx/naked?label=sickcodes%2Fdocker-osx%3Anaked](https://img.shields.io/docker/image-size/sickcodes/docker-osx/naked?label=sickcodes%2Fdocker-osx%3Anaked)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated)
+#### Prebuilt image with arbitrary command line arguments
+[![https://img.shields.io/docker/image-size/sickcodes/docker-osx/auto?label=sickcodes%2Fdocker-osx%3Aauto](https://img.shields.io/docker/image-size/sickcodes/docker-osx/auto?label=sickcodes%2Fdocker-osx%3Aauto)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated)
-This is a particularly good way for downloading the container, in case Docker's CDN (or your connection) happens to be slow.
+`-e OSX_COMMANDS` lets you run any commands inside the container
```bash
-wget https://images2.sick.codes/mac_hdd_ng_auto.img
+docker pull sickcodes/docker-osx:auto
+# boot to OS X shell + display + specify commands to run inside OS X!
docker run -it \
--device /dev/kvm \
-p 50922:10022 \
- -v "${PWD}/mac_hdd_ng_auto.img:/image" \
-v /tmp/.X11-unix:/tmp/.X11-unix \
-e "DISPLAY=${DISPLAY:-:0.0}" \
- sickcodes/docker-osx:naked
+ -e "OSX_COMMANDS=/bin/bash -c \"put your commands here\"" \
+ sickcodes/docker-osx:auto
+
+# Boots in a minute or two!
```
-#### Prebuilt image with arbitrary command line arguments
-[![https://img.shields.io/docker/image-size/sickcodes/docker-osx/auto?label=sickcodes%2Fdocker-osx%3Aauto](https://img.shields.io/docker/image-size/sickcodes/docker-osx/auto?label=sickcodes%2Fdocker-osx%3Aauto)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated)
+```bash
+
+OR if you have an image already and just want to log in and execute arbitrary commands:
```bash
-docker pull sickcodes/docker-osx:auto
+docker pull sickcodes/docker-osx:naked-auto
# boot to OS X shell + display + specify commands to run inside OS X!
docker run -it \
@@ -1138,10 +1210,13 @@ docker run -it \
-p 50922:10022 \
-v /tmp/.X11-unix:/tmp/.X11-unix \
-e "DISPLAY=${DISPLAY:-:0.0}" \
- -e "OSX_COMMANDS=/bin/bash -c \"pwd && uname -a\"" \
- sickcodes/docker-osx:auto
+ -e USERNAME=yourusername \
+ -e USERNAME=yourpassword \
+ -e "OSX_COMMANDS=/bin/bash -c \"put your commands here\"" \
+ sickcodes/docker-osx:naked-auto
# Boots in a minute or two!
+
```
### Further examples
@@ -1258,23 +1333,6 @@ docker run \
newImageName
```
-#### Run Catalina Pre-Installed [![https://img.shields.io/docker/image-size/sickcodes/docker-osx/auto?label=sickcodes%2Fdocker-osx%3Aauto](https://img.shields.io/docker/image-size/sickcodes/docker-osx/auto?label=sickcodes%2Fdocker-osx%3Aauto)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated)
-
-```bash
-docker pull sickcodes/docker-osx:auto
-
-# boot directly into a real OS X shell with a visual display [NOT HEADLESS]
-docker run -it \
- --device /dev/kvm \
- -p 50922:10022 \
- -v /tmp/.X11-unix:/tmp/.X11-unix \
- -e "DISPLAY=${DISPLAY:-:0.0}" \
- sickcodes/docker-osx:auto
-
-# username is user
-# passsword is alpine
-```
-
```bash
docker pull sickcodes/docker-osx:auto