Docker-OSX/README.md

1199 lines
40 KiB
Markdown
Raw Normal View History

2021-03-19 03:25:27 -05:00
# Docker-OSX · [Follow @sickcodes on Twitter](https://twitter.com/sickcodes)
2020-09-20 03:49:12 -05:00
2021-03-19 03:25:27 -05:00
![Running Mac OS X in a Docker container](/running-mac-inside-docker-qemu.png?raw=true "OSX KVM DOCKER")
2021-03-19 03:25:27 -05:00
Run Mac OS X in Docker with near-native performance! X11 Forwarding! iMessage security research!
2021-03-19 03:25:27 -05:00
## Author
This project is maintained by [Sick.Codes](https://sick.codes/). [(Twitter)](https://twitter.com/sickcodes)
2021-03-19 03:25:27 -05:00
Additional credits can be found here: https://github.com/sickcodes/Docker-OSX/blob/master/CREDITS.md
2021-02-02 20:04:22 -06:00
2021-03-19 03:25:27 -05:00
Additionally, comprehensive list of all contributors can be found here: https://github.com/sickcodes/Docker-OSX/graphs/contributors
Special thanks to [@kholia](https://twitter.com/kholia) for maintaining the upstream project, which Docker-OSX is built on top of: [OSX-KVM](https://github.com/kholia/OSX-KVM).
2021-03-26 06:58:16 -05:00
Big thanks to the OpenCore team over at: https://github.com/acidanthera/OpenCorePkg. Their well-maintained bootloader provides much of the great functionality that Docker-OSX users enjoy :)
If you like this project, consider contributing here or upstream!
## Quick Start Docker-OSX
### Catalina [![https://img.shields.io/docker/image-size/sickcodes/docker-osx/latest?label=sickcodes%2Fdocker-osx%3Alatest](https://img.shields.io/docker/image-size/sickcodes/docker-osx/latest?label=sickcodes%2Fdocker-osx%3Alatest)](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}" \
sickcodes/docker-osx:latest
```
### Big Sur [![https://img.shields.io/docker/image-size/sickcodes/docker-osx/big-sur?label=sickcodes%2Fdocker-osx%3Abig-sur](https://img.shields.io/docker/image-size/sickcodes/docker-osx/big-sur?label=sickcodes%2Fdocker-osx%3Abig-sur)](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}" \
sickcodes/docker-osx:big-sur
```
## Technical details
2021-03-26 06:58:16 -05:00
There currently 4 images, each with different use-cases (explained below):
[![https://img.shields.io/docker/image-size/sickcodes/docker-osx/latest?label=sickcodes%2Fdocker-osx%3Alatest](https://img.shields.io/docker/image-size/sickcodes/docker-osx/latest?label=sickcodes%2Fdocker-osx%3Alatest)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated)
[![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)
[![https://img.shields.io/docker/image-size/sickcodes/docker-osx/big-sur?label=sickcodes%2Fdocker-osx%3Abig-sur](https://img.shields.io/docker/image-size/sickcodes/docker-osx/big-sur?label=sickcodes%2Fdocker-osx%3Abig-sur)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated)
[![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)
The images (excluding `:naked`) launch a container with an existing installation with a couple of premade configurations. This special image was developed by [Sick.Codes](https://sick.codes):
- username: `user`, password: `alpine`
2021-03-26 06:58:16 -05:00
- SSH enabled (`localhost:50922`)
- VNC enabled (`localhost:8888`) if using ./vnc version
- VNC enabled (`localhost:8888`) if using ./vnc version
- auto-updates disabled
2021-03-26 06:58:16 -05:00
- [serial number generator!](https://github.com/sickcodes/osx-serial-generator)
- X11 forwarding is enabled
- runs on top of QEMU + KVM
2021-03-26 06:58:16 -05:00
- supports Big Sur, custom images, Xvfb headless mode
- you can clone your container with `docker commit`
### Requirements
2021-03-26 06:58:16 -05:00
- 20GB disk space for bare minimum installation
- virtualization should be enabled in your BIOS settings
- a kvm-capable host
2021-03-26 06:58:16 -05:00
- at least 50 GBs for `:auto` (half for the base image, half for your runtime image
2021-03-26 06:58:16 -05:00
### TODO
- documentation for security researchers
- gpu acceleration
- support for virt-manager
2021-03-19 03:25:27 -05:00
## Docker
2021-02-27 06:10:08 -06:00
2021-03-19 03:25:27 -05:00
Images built on top of the contents of this repository are also available on **Docker Hub** for convenience: https://hub.docker.com/r/sickcodes/docker-osx
A comprehensive list of the available Docker images and their intended purpose can be found in the [Instructions](README.md#Instructions).
2021-03-19 03:25:27 -05:00
## Kubernetes
2021-03-19 03:25:27 -05:00
Docker-OSX supports Kubernetes.
2021-02-02 20:04:22 -06:00
Kubernetes Helm Chart & Documentation can be found under the [helm directory](helm/README.md).
2021-03-19 03:25:27 -05:00
Thanks [cephasara](https://github.com/cephasara) for contributing this major contribution.
2021-02-02 20:04:22 -06:00
2021-03-19 03:25:27 -05:00
[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/docker-osx)](https://artifacthub.io/packages/search?repo=docker-osx)
## Support
### Small questions & issues
Feel free to open an [issue](https://github.com/sickcodes/Docker-OSX/issues/new/choose), should you come across minor issues with running Docker-OSX or have any questions.
#### Resolved issues
Before you open an issue, however, please check the [closed issues](https://github.com/sickcodes/Docker-OSX/issues?q=is%3Aissue+is%3Aclosed) and confirm that you're using the latest version of this repository — your issues may have already been resolved!
### Feature requests and updates
2021-03-19 03:25:27 -05:00
Follow [@sickcodes](https://twitter.com/sickcodes)!
### Professional support
For more sophisticated endeavours, we offer the following support services:
- Enterprise support, business support, or casual support.
2021-02-02 20:04:22 -06:00
- Custom images, custom scripts, consulting (per hour available!)
2021-03-19 03:25:27 -05:00
- One-on-one conversations with you or your development team.
2021-02-02 20:04:22 -06:00
2021-03-19 03:25:27 -05:00
In case you're interested, contact [@sickcodes on Twitter](https://twitter.com/sickcodes) or click [here](https://sick.codes/contact).
2021-03-19 03:25:27 -05:00
## License/Contributing
Docker-OSX is licensed under the [GPL v3+](LICENSE). Contributions are welcomed and immensely appreciated. You are in-fact permitted to use Docker-OSX as a tool to create proprietary software.
### Other cool Docker/QEMU based projects
- [Run iOS in a Docker container with Docker-eyeOS](https://github.com/sickcodes/Docker-eyeOS) - [https://github.com/sickcodes/Docker-eyeOS](https://github.com/sickcodes/Docker-eyeOS)
2021-03-19 03:25:27 -05:00
## Disclaimer
2021-02-02 20:04:22 -06:00
If you are serious about Apple Security, and possibly finding 6-figure bug bounties within the Apple Bug Bounty Program, then you're in the right place! Further notes: [Is Hackintosh, OSX-KVM, or Docker-OSX legal?](https://sick.codes/is-hackintosh-osx-kvm-or-docker-osx-legal/).
Product names, logos, brands and other trademarks referred to within this project are the property of their respective trademark holders. These trademark holders are not affiliated with our repository in any capacity. They do not sponsor or endorse this project in any way.
2021-03-19 03:25:27 -05:00
## Instructions
2021-03-19 03:25:27 -05:00
### Container images
2021-03-19 03:25:27 -05:00
There are three different Docker images available, which are suitable for different purposes: **latest**, **auto** and **naked**.
2021-03-19 03:25:27 -05:00
- `sickcodes/docker-osx:latest` - [I just want to try it out.](https://github.com/sickcodes/Docker-OSX#quick-start-large-pre-made-image)
- `sickcodes/docker-osx:latest` - [I want to use Docker-OSX to develop/secure apps in Xcode (sign into Xcode, Transporter)](https://github.com/sickcodes/Docker-OSX#basic-quick-start-docker-osx)
- `sickcodes/docker-osx:naked` - [I want to use Docker-OSX for CI/CD-related purposes (sign into Xcode, Transporter)](https://github.com/sickcodes/Docker-OSX#fully-headless-using-my-own-image-for-cicd)
2021-03-19 03:25:27 -05:00
Create your personal image using `:latest`. Then, extract the image. Afterwards, you will be able to duplicate that image and import it to the `:naked` container, in order to revert the container to a previous state repeatedly.
2021-03-19 03:25:27 -05:00
- `sickcodes/docker-osx:auto` - [I'm only interested in using the command line. (Useful for compiling software or using Homebrew headlessly).](https://github.com/sickcodes/Docker-OSX#pre-built-image-arbitrary-command-line-arguments)
- `sickcodes/docker-osx:naked` - [I need iMessage/iCloud for security research.](https://github.com/sickcodes/Docker-OSX#serial-numbers)
2021-03-26 06:58:16 -05:00
## I need video output.
2021-03-19 03:25:27 -05:00
The Quick Start command should work out of the box, provided that you keep the following lines. Works in `auto` & `naked` machines:
```
-v /tmp/.X11-unix:/tmp/.X11-unix \
-e "DISPLAY=${DISPLAY:-:0.0}" \
```
2021-03-26 06:58:16 -05:00
## I need to use Docker-OSX headlessly.
2021-03-19 03:25:27 -05:00
In that case, **remove** the two lines in your command:
```
# -v /tmp/.X11-unix:/tmp/.X11-unix \
# -e "DISPLAY=${DISPLAY:-:0.0}" \
```
2021-03-26 06:58:16 -05:00
## I need VNC on localhost (Local use only!)
### VNC Insecure
**Must change -it to -i to be able to interact with the QEMU console**
2021-03-31 04:10:12 -05:00
**To exit a container using -i you must `docker kill <containerid>`. For example, to kill everything, `docker ps | xargs docker kill`.**
2021-03-26 06:58:16 -05:00
Native QEMU VNC example
```bash
docker run -i \
--device /dev/kvm \
-p 50922:10022 \
-p 5999:5999 \
-v /tmp/.X11-unix:/tmp/.X11-unix \
-e "DISPLAY=${DISPLAY:-:0.0}" \
-e EXTRA="-display none -vnc 0.0.0.0:99,password" \
sickcodes/docker-osx:big-sur
# type `change vnc password` into the docker terminal and set a password
# connect to localhost:5999 using VNC
```
**NOT TLS/HTTPS Encrypted at all!**
Or `ssh -N root@1.1.1.1 -L 5999:127.0.0.1:5999`, where `1.1.1.1` is your remote server IP.
(Note: if you close port 5999 and use the SSH tunnel, this becomes secure.)
## I need VNC to a Remote Host (Secure)
Now you can direct connect VNC to any image!
Add the following line:
`-e EXTRA="-display none -vnc 0.0.0.0:99,password"`
In the Docker terminal, press `enter` until you see `(qemu)`.
Type `change vnc password`
2021-03-26 06:58:16 -05:00
You also need the container IP: `docker inspect <containerid> | jq -r '.[0].NetworkSettings.IPAddress'`
2021-03-26 06:58:16 -05:00
Or `ip n` will usually show the container IP first.
Now VNC connect using the Docker container IP, for example `172.17.0.2:5999`
Remote VNC over SSH: `ssh -N root@1.1.1.1 -L 5999:172.17.0.2:5999`, where `1.1.1.1` is your remote server IP and `172.17.0.2` is your LAN container IP.
2021-03-19 03:25:27 -05:00
#### I have used Docker-OSX before and wish to extract my Mac OS X image.
Use `docker commit`, copy the ID, and then run `docker start -ai <Replace this with your ID>`.
2021-03-19 03:25:27 -05:00
**Alternatively:**
2021-03-19 03:25:27 -05:00
[Extract the .img file](https://github.com/sickcodes/Docker-OSX#backup-the-disk-wheres-my-disk), and then use that [.img file with :naked](https://github.com/sickcodes/Docker-OSX#quick-start-own-image-naked-container-image)
#### Further examples
2021-03-26 06:58:16 -05:00
Apart from the previous examples, there's a myriad of other potential use cases that can work perfectly with Docker-OSX, which you'll see below!
2021-03-26 06:58:16 -05:00
### 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
2021-03-26 06:58:16 -05:00
# boot directly into a real OS X shell with a visual display [NOT HEADLESS]
docker run -it \
--device /dev/kvm \
-p 50922:10022 \
2021-03-26 06:58:16 -05:00
-v /tmp/.X11-unix:/tmp/.X11-unix \
-e "DISPLAY=${DISPLAY:-:0.0}" \
sickcodes/docker-osx:auto
2021-03-26 06:58:16 -05:00
# username is user
# passsword is alpine
```
```bash
docker pull sickcodes/docker-osx:auto
2021-03-26 06:58:16 -05:00
# boot directly into a real OS X shell with no display (Xvfb) [HEADLESS]
docker run -it \
--device /dev/kvm \
-p 50922:10022 \
sickcodes/docker-osx:auto
2021-03-26 06:58:16 -05:00
# username is user
# passsword is alpine
# Wait 2-3 minutes until you drop into the shell.
```
2021-03-26 06:58:16 -05:00
### 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
```
2021-03-19 03:25:27 -05:00
2021-03-26 06:58:16 -05:00
### Use a pre-built image + 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
docker pull sickcodes/docker-osx:auto
2021-03-19 03:25:27 -05:00
# boot to OS X shell + display + specify commands to run inside OS X!
docker run -it \
--device /dev/kvm \
-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
# Boots in a minute or two!
```
2021-03-19 03:25:27 -05:00
2021-03-26 06:58:16 -05:00
### Run Mac OS X headlessly with a custom image [![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 particularly helpful for CI/CD pipelines.
```bash
# run your own image headless + SSH
docker run -it \
--device /dev/kvm \
-p 50922:10022 \
-v "${PWD}/mac_hdd_ng.img:/image" \
sickcodes/docker-osx:naked
```
### Restart a container that starts automatically
2021-03-19 03:25:27 -05:00
Containers that use `sickcodes/docker-osx:auto` can be stopped while being started.
```bash
# find last container
docker ps -a
# docker start old container with -i for interactive, -a for attach STDIN/STDOUT
docker start -ai -i <Replace this with your ID>
```
### Quick Start your own image (naked container image)
This is my favourite container. You can supply an existing disk image as a Docker command line argument.
- Pull images out using `sudo find /var/lib/docker -size +10G | grep mac_hdd_ng.img`
- Supply your own local image with the command argument `-v "${PWD}/mac_hdd_ng.img:/image"` and use `sickcodes/docker-osx:naked` when instructing Docker to create your container.
- Naked image is for booting any existing .img file, e.g in the current working directory (`$PWD`)
- By default, this image has a variable called `NOPICKER` which is `"true"`. This skips the disk selection menu. Use `-e NOPICKER=false` or any other string than the word `true` to enter the boot menu.
This lets you use other disks instead of skipping the boot menu, e.g. recovery disk or disk utility.
```bash
docker pull sickcodes/docker-osx:naked
# run your own image + SSH
# change mac_hdd_ng.img
docker run -it \
--device /dev/kvm \
-p 50922:10022 \
-v "${PWD}/mac_hdd_ng.img:/image" \
-v /tmp/.X11-unix:/tmp/.X11-unix \
-e "DISPLAY=${DISPLAY:-:0.0}" \
sickcodes/docker-osx:naked
# run local copy of the auto image + SSH + Boot menu
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 "NOPICKER=false" \
sickcodes/docker-osx:naked
```
### Run the original version of Docker-OSX
2020-06-04 22:49:15 -05:00
2020-09-20 03:49:12 -05:00
```bash
2020-06-04 13:35:57 -05:00
2020-09-26 01:26:38 -05:00
docker pull sickcodes/docker-osx:latest
2020-06-04 13:35:57 -05:00
docker run -it \
2020-10-06 11:42:34 -05:00
--device /dev/kvm \
--device /dev/snd \
-v /tmp/.X11-unix:/tmp/.X11-unix \
-e "DISPLAY=${DISPLAY:-:0.0}" \
sickcodes/docker-osx:latest
2020-06-04 13:35:57 -05:00
# press CTRL + G if your mouse gets stuck
2020-06-04 23:11:30 -05:00
# scroll down to troubleshooting if you have problems
# need more RAM and SSH on localhost -p 50922?
2020-10-06 11:42:34 -05:00
```
2021-03-19 03:25:27 -05:00
# Run but enable SSH in OS X (Original Version)!
2020-10-06 11:42:34 -05:00
```bash
docker run -it \
2020-10-06 11:42:34 -05:00
--device /dev/kvm \
--device /dev/snd \
-p 50922:10022 \
-v /tmp/.X11-unix:/tmp/.X11-unix \
2020-10-06 11:42:34 -05:00
-e "DISPLAY=${DISPLAY:-:0.0}" \
sickcodes/docker-osx:latest
2020-06-15 08:07:37 -05:00
2021-03-19 03:25:27 -05:00
# turn on SSH after you've installed OS X in the "Sharing" settings.
ssh user@localhost -p 50922
2020-06-04 16:10:05 -05:00
```
### Autoboot into OS X after you've installed everything
You can use `-e NOPICKER=true`.
Old machines:
```bash
# find you containerID
docker ps
# move the no picker script on top of the Launch script
# NEW CONTAINERS
docker exec containerID mv ./Launch-nopicker.sh ./Launch.sh
# VNC-VERSION-CONTAINER
docker exec containerID mv ./Launch-nopicker.sh ./Launch_custom.sh
# LEGACY CONTAINERS
docker exec containerID bash -c "grep -v InstallMedia ./Launch.sh > ./Launch-nopicker.sh
chmod +x ./Launch-nopicker.sh
sed -i -e s/OpenCore\.qcow2/OpenCore\-nopicker\.qcow2/ ./Launch-nopicker.sh
"
```
2020-06-04 20:57:01 -05:00
# Requirements: KVM on the host
2020-06-04 19:27:49 -05:00
Need to turn on hardware virtualization in your BIOS, very easy to do.
2020-10-06 11:42:34 -05:00
Then have QEMU on the host if you haven't already
2020-09-20 03:49:12 -05:00
```bash
2020-06-04 19:27:49 -05:00
# ARCH
2020-09-20 03:49:12 -05:00
sudo pacman -S qemu libvirt dnsmasq virt-manager bridge-utils flex bison iptables-nft edk2-ovmf
2020-06-04 19:27:49 -05:00
# UBUNTU DEBIAN
sudo apt install qemu qemu-kvm libvirt-clients libvirt-daemon-system bridge-utils virt-manager
# CENTOS RHEL FEDORA
2020-10-06 11:42:34 -05:00
sudo yum install libvirt qemu-kvm
2020-06-04 19:27:49 -05:00
# then run
2021-03-20 04:00:43 -05:00
sudo systemctl enable --now libvirtd
sudo systemctl enable --now virtlogd
echo 1 | sudo tee /sys/module/kvm/parameters/ignore_msrs
2020-06-04 19:27:49 -05:00
sudo modprobe kvm
```
2020-10-03 18:36:12 -05:00
2020-06-04 16:10:05 -05:00
# Start the same container later (persistent disk)
2020-06-04 23:11:30 -05:00
1. You can now pull the `.img` file out of the container, which is stored in `/var/lib/docker`, and supply it as a runtime argument to the `:naked` Docker image. See above.
2. This is for when you want to run the SAME container again later.
2020-06-04 23:11:30 -05:00
If you don't run this you will have a new image every time.
2020-09-20 03:49:12 -05:00
```bash
# look at your recent containers and copy the CONTAINER ID
docker ps --all
2020-06-04 16:10:05 -05:00
# docker start the container ID
docker start -ai abc123xyz567
2020-06-04 22:49:15 -05:00
# if you have many containers, you can try automate it with filters like this
# docker ps --all --filter "ancestor=sickcodes/docker-osx"
# for locally tagged/built containers
# docker ps --all --filter "ancestor=docker-osx"
2020-06-04 22:49:15 -05:00
2020-06-04 13:31:47 -05:00
```
2020-06-04 15:25:29 -05:00
# Additional Boot Instructions
2020-09-20 03:49:12 -05:00
- Boot the macOS Base System
2020-06-04 15:25:29 -05:00
2020-10-06 11:42:34 -05:00
- Click `Disk Utility`
2020-06-04 15:25:29 -05:00
2020-09-20 03:49:12 -05:00
- Erase the BIGGEST disk (around 200gb default), DO NOT MODIFY THE SMALLER DISKS.
2020-10-06 11:42:34 -05:00
-- if you can't click `erase`, you may need to reduce the disk size by 1kb
2020-06-04 15:25:29 -05:00
- (optional) Create a partition using the unused space to house the OS and your files if you want to limit the capacity. (For Xcode 12 partition at least 60gb.)
2020-10-06 11:42:34 -05:00
- Click `Reinstall macOS`
2020-06-04 15:25:29 -05:00
2020-08-23 15:22:45 -05:00
## Creating images:
2020-09-20 03:49:12 -05:00
```bash
2020-10-06 11:42:34 -05:00
# You can create an image of an already configured and setup container.
# This allows you to effectively duplicate a system.
2020-08-23 15:22:45 -05:00
# To do this, run the following commands
2020-10-06 11:42:34 -05:00
# make note of your container id
docker ps --all
2020-10-06 11:42:34 -05:00
docker commit containerid newImageName
2020-08-23 15:22:45 -05:00
# To run this image do the following
2020-10-06 11:42:34 -05:00
docker run \
--device /dev/kvm \
--device /dev/snd \
-v /tmp/.X11-unix:/tmp/.X11-unix \
newImageName
2020-08-23 15:22:45 -05:00
```
## Troubleshooting
Big thank you to our contributors who have worked out almost every conceivable issue so far!
### LibGTK - Permission denied
[https://github.com/sickcodes/Docker-OSX/blob/master/CREDITS.md](https://github.com/sickcodes/Docker-OSX/blob/master/CREDITS.md)
#### libgtk permissions denied error
2020-06-05 13:41:37 -05:00
2020-09-20 03:49:12 -05:00
```bash
2020-06-05 13:41:37 -05:00
echo $DISPLAY
# ARCH
sudo pacman -S xorg-xhost
# UBUNTU DEBIAN
sudo apt install x11-xserver-utils
# CENTOS RHEL FEDORA
sudo yum install xorg-x11-server-utils
2020-06-05 07:53:19 -05:00
# then run
xhost +
2020-06-04 22:49:15 -05:00
```
#### RAM over-allocation Error
Cause by trying to allocate more ram to the container than you currently have available for allocation: `cannot set up guest memory 'pc.ram': Cannot allocate memory`.
For example:
```console
[user@hostname ~]$ free -mh
total used free shared buff/cache available
Mem: 30Gi 3.5Gi 7.0Gi 728Mi 20Gi 26Gi
Swap: 11Gi 0B 11Gi
```
In the example above, the `buff/cache` already contains 20 Gigabytes of allocated RAM.
Clear the buffer and the cache:
```bash
sudo tee /proc/sys/vm/drop_caches <<< 3
```
Now check the ram again:
```console
[user@hostname ~]$ free -mh
total used free shared buff/cache available
Mem: 30Gi 3.3Gi 26Gi 697Mi 1.5Gi 26Gi
Swap: 11Gi 0B 11Gi
2020-06-04 22:49:15 -05:00
```
Of course you cannot allocate more RAM that your have. The default is 3 Gigabytes: `-e RAM=3`.
#### PulseAudio
2020-06-04 22:49:15 -05:00
### Use PulseAudio for sound
Note: [AppleALC](https://github.com/acidanthera/AppleALC), [`alcid`](https://dortania.github.io/OpenCore-Post-Install/universal/audio.html) and [VoodooHDA-OC](https://github.com/chris1111/VoodooHDA-OC) do not have [codec support](https://osy.gitbook.io/hac-mini-guide/details/hda-fix#hda-codec). However, [IORegistryExplorer](https://github.com/vulgo/IORegistryExplorer) does show the controller component working.
2020-10-06 11:42:34 -05:00
```bash
2020-10-06 11:42:34 -05:00
docker run \
--device /dev/kvm \
-e AUDIO_DRIVER=pa,server=unix:/tmp/pulseaudio.socket \
-v "/run/user/$(id -u)/pulse/native:/tmp/pulseaudio.socket" \
-v /tmp/.X11-unix:/tmp/.X11-unix \
sickcodes/docker-osx
```
2020-10-06 11:42:34 -05:00
#### PulseAudio debugging
```bash
2020-10-06 11:42:34 -05:00
docker run \
--device /dev/kvm \
-e AUDIO_DRIVER=pa,server=unix:/tmp/pulseaudio.socket \
-v "/run/user/$(id -u)/pulse/native:/tmp/pulseaudio.socket" \
-v /tmp/.X11-unix:/tmp/.X11-unix \
-e PULSE_SERVER=unix:/tmp/pulseaudio.socket \
sickcodes/docker-osx pactl list
```
#### Nested Hardware Virtualization
Check if your PC has hardware virtualization enabled:
2020-09-20 03:49:12 -05:00
```bash
sudo tee /sys/module/kvm/parameters/ignore_msrs <<< 1
egrep -c '(svm|vmx)' /proc/cpuinfo
2020-09-20 03:49:12 -05:00
```
2020-06-04 23:11:30 -05:00
### Routine checks
#### Confirm that your CPU supports virtualization
#### Add yourself to the Docker group, KVM group, libvirt group.
If you use `sudo dockerd` or dockerd is controlled by systemd/systemctl, then you must be in the Docker group:
2020-06-04 20:39:15 -05:00
#### Try adding yourself to the docker group
2020-09-20 03:49:12 -05:00
```bash
sudo usermod -aG docker "${USER}"
```
2021-03-26 06:20:02 -05:00
and also to the kvm and libvirt groups:
2020-09-20 03:49:12 -05:00
```bash
sudo usermod -aG libvirt "${USER}"
sudo usermod -aG kvm "${USER}"
2020-09-20 03:49:12 -05:00
```
2020-06-04 20:39:15 -05:00
#### Enable docker daemon
2020-09-20 03:49:12 -05:00
```bash
# enable it in systemd
sudo systemctl enable --now docker
# or run ad hoc
2020-09-20 03:49:12 -05:00
sudo dockerd
2020-10-06 11:42:34 -05:00
2020-09-20 03:49:12 -05:00
# or daemonize it
sudo nohup dockerd &
```
2020-06-04 16:42:21 -05:00
#### Forward additional ports (nginx)
It's possible to forward additional ports depending on your needs. In this example, we're going to use Mac OS X to host nginx in a way that looks like this:
```
host:10023 <-> 10023:container:10023 <-> 80:guest
```
On the host machine, you should run:
```bash
docker run -it \
--device /dev/kvm \
-p 50922:10022 \
-e ADDITIONAL_PORTS='hostfwd=tcp::10023-:80,' \
-p 10023:10023 \
sickcodes/docker-osx:auto
```
In a Terminal session running the container, you should run:
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install nginx
sudo sed -i -e 's/8080/80/' /usr/local/etc/nginx/nginx.confcd
# sudo nginx -s stop
sudo nginx
```
**nginx should now be reachable on the port 10023.**
Additionally, you can string multiple statements, for example:
```bash
-e ADDITIONAL_PORTS='hostfwd=tcp::10023-:80,hostfwd=tcp::10043-:443,'
-p 10023:10023 \
-p 10043:10043 \
```
### Enable IPv4 forwarding for bridged network connections
2020-10-06 11:42:34 -05:00
This is not required for LOCAL installations and may [cause the host to leak your IP, even if you're using a VPN in the container](https://sick.codes/cve-2020-15590/).
2020-10-06 11:42:34 -05:00
However, if you're trying to connect to an instance of Docker-OSX remotely (e.g. an instance of Docker-OSX hosted in a datacenter), this may improve your performance:
2020-06-04 16:42:21 -05:00
2020-09-20 03:49:12 -05:00
```bash
2020-10-06 11:42:34 -05:00
# enable for current session
sudo sysctl -w net.ipv4.ip_forward=1
2020-06-04 16:42:21 -05:00
2020-10-06 11:42:34 -05:00
# OR
# sudo tee /proc/sys/net/ipv4/ip_forward <<< 1
# enable permanently
sudo touch /etc/sysctl.conf
sudo tee -a /etc/sysctl.conf <<EOF
net.ipv4.ip_forward = 1
EOF
# or edit manually with the editor of your choice
2020-10-06 11:42:34 -05:00
nano /etc/sysctl.conf || vi /etc/sysctl.conf || vim /etc/sysctl.conf
# now reboot
```
### Fedora: No internet connectivity with a bridged network
2020-10-06 11:42:34 -05:00
Fedora's default firewall settings may prevent Docker's network interface from reaching the internet. In order to reoslve this, you will need to whitelist the interface in your firewall:
2020-09-20 03:49:12 -05:00
```bash
# Set the docker0 bridge to the trusted zone
sudo firewall-cmd --permanent --zone=trusted --add-interface=docker0
sudo firewall-cmd --reload
```
### Virtual network adapters
2020-06-04 16:23:16 -05:00
#### Fast internet connectivity
2020-06-04 16:23:16 -05:00
`-e NETWORKING=vmxnet3`
#### Slow internet connectivity
`-e NETWORKING=e1000-82545em`
2020-06-04 16:23:16 -05:00
### I'd like to use SPICE instead of VNC
Optionally, you can enable the SPICE protocol, which allows you to use `remote-viewer` to access it rather than VNC.
2020-10-06 11:42:34 -05:00
Note: `-disable-ticketing` will allow unauthenticated access to the VM. See the [spice manual](https://www.spice-space.org/spice-user-manual.html) for help setting up authenticated access ("Ticketing").
2020-10-06 11:42:34 -05:00
2020-09-20 03:49:12 -05:00
```bash
docker run \
--device /dev/kvm \
-p 50922:10022 \
-e "DISPLAY=${DISPLAY:-:0.0}" \
-e EXTRA="-monitor telnet::45454,server,nowait -nographic -serial null -spice disable-ticketing,port=3001" \
mycustomimage
2020-06-04 16:10:05 -05:00
```
Then simply do `remote-viewer spice://localhost:3001` and add `--spice-debug` for debugging.
### CI/CD Related Improvements
#### Tips for reducing the size of the image
- Start the container as usual, and remove unnecessary files. A useful way
to do this is to use `du -sh *` starting from the `/` directory, and find
large directories where files can be removed. E.g. unnecessary cached files,
Xcode platforms, etc.
- Once you are satisfied with the amount of free space, enable trim with `sudo trimforce enable`, and reboot.
- Zero out the empty space on the disk with `dd if=/dev/zero of=./empty && rm -f empty`
- Shut down the VM and copy out the qcow image with `docker cp stoppedcontainer:/home/arch/OSX-KVM/mac_hdd_ng.img .`
- Run `qemu-img check -r all mac_hdd_ng.img` to fix any errors.
- Run `qemu-img convert -O qcow2 mac_hdd_ng.img deduped.img` and check for errors again
- **OPTIONAL:** Run `qemu-img convert -c -O qcow2 deduped.img compressed.img` to further compress the image. This may reduce the runtime speed though, but it should reduce the size by roughly 25%.
- Check for errors again, and build a fresh docker image. E.g. with this Dockerfile
```
FROM sickcodes/docker-osx
USER arch
COPY --chown=arch ./deduped.img /home/arch/OSX-KVM/mac_hdd_ng.img
```
### Run Docker-OSX headlessly with Telnet
First make sure [autoboot is enabled](#autoboot-into-osx-after-youve-installed-everything)
Next, you will want to set up SSH to be automatically started.
```bash
sudo systemsetup -setremotelogin on
```
Make sure to commit the new docker image and save it, or rebuild as described in the [section on reducing disk space](#how-to-reduce-the-size-of-the-image).
Then run it with these arguments.
```bash
# Run with the -nographic flag, and enable a telnet interface
docker run \
--device /dev/kvm \
-p 50922:10022 \
-e "DISPLAY=${DISPLAY:-:0.0}" \
-e EXTRA="-monitor telnet::45454,server,nowait -nographic -serial null" \
mycustomimage
```
## Setting the appropriate mirrors when building locally
If you are building Docker-OSX locally, you'd probably want to use Arch Linux's mirrors.
Mirror locations can be found here (use 2 letter country codes): https://archlinux.org/mirrorlist/all/
2020-06-04 13:31:47 -05:00
2020-09-20 03:49:12 -05:00
```bash
2020-06-04 13:31:47 -05:00
docker build -t docker-osx:latest \
--build-arg RANKMIRRORS=true \
--build-arg MIRROR_COUNTRY=US \
--build-arg MIRROR_COUNT=10 \
--build-arg VERSION=10.15.6 \
--build-arg SIZE=200G .
2020-09-20 03:49:12 -05:00
```
2020-06-04 13:31:47 -05:00
### Custom QEMU Arguments (passthrough devices)
Pass any devices/directories to the Docker container & the QEMU arguments using the handy `-e EXTRA=` runtime options.
2020-09-20 03:49:12 -05:00
```bash
# example customizations
docker run \
-e RAM=4 \
-e SMP=4 \
-e CORES=4 \
-e EXTRA='-usb -device usb-host,hostbus=1,hostaddr=8' \
-e INTERNAL_SSH_PORT=23 \
-e MAC_ADDRESS="$(xxd -c1 -p -l 6 /dev/urandom | tr '\n' ':' | cut -c1-17)" \
-e AUDIO_DRIVER=alsa \
-e IMAGE_PATH=/image \
-e SCREEN_SHARE_PORT=5900 \
-e DISPLAY=:0 \
-e NETWORKING=vmxnet3 \
--device /dev/kvm \
--device /dev/snd \
-v /tmp/.X11-unix:/tmp/.X11-unix \
docker-osx:latest
2020-06-04 13:31:47 -05:00
```
### Generating serial numbers
For serial numbers, generate them in `./custom` OR make docker generate them at runtime (see below).
At any time, verify your serial number before logging in iCloud, etc.
```bash
2021-03-19 03:25:27 -05:00
# this is a quick way to check your serial number via cli inside OS X
ioreg -l | grep IOPlatformSerialNumber
# or from the host
sshpass -p 'alpine' ssh user@localhost -p 50922 'ioreg -l | grep IOPlatformSerialNumber'
```
# This example generates a random set of serial numbers at runtime, headlessly
```bash
# proof of concept only, generates random serial numbers, headlessly, and quits right after.
docker run --rm -it \
--device /dev/kvm \
-p 50922:10022 \
-e NOPICKER=true \
-e GENERATE_UNIQUE=true \
-e DEVICE_MODEL="iMacPro1,1" \
-e OSX_COMMANDS='ioreg -l | grep IOPlatformSerialNumber' \
sickcodes/docker-osx:auto
```
# This example generates a specific set of serial numbers at runtime
```bash
# run the same as above 17gb auto image, with SSH, with nopicker, and save the bootdisk for later.
# you don't need to save the bootdisk IF you supply specific serial numbers!
docker run -it \
--device /dev/kvm \
-p 50922:10022 \
-e NOPICKER=true \
-e GENERATE_SPECIFIC=true \
-e DEVICE_MODEL="iMacPro1,1" \
-e SERIAL="C02TW0WAHX87" \
-e BOARD_SERIAL="C027251024NJG36UE" \
-e UUID="5CCB366D-9118-4C61-A00A-E5BAF3BED451" \
-e MAC_ADDRESS="A8:5C:2C:9A:46:2F" \
-e OSX_COMMANDS='ioreg -l | grep IOPlatformSerialNumber' \
sickcodes/docker-osx:auto
```
#### This example generates a specific set of serial numbers at runtime, with your existing image, at 1000x1000 display resolution.
```bash
2021-03-09 16:06:35 -06:00
# run an existing image in current directory, with a screen, with SSH, with nopicker.
stat mac_hdd_ng.img # make sure you have an image if you're using :naked
docker run -it \
2021-03-09 16:06:35 -06:00
-v "${PWD}/mac_hdd_ng.img:/image" \
--device /dev/kvm \
-e "DISPLAY=${DISPLAY:-:0.0}" \
-v /tmp/.X11-unix:/tmp/.X11-unix \
-p 50922:10022 \
-e NOPICKER=true \
-e GENERATE_SPECIFIC=true \
-e DEVICE_MODEL="iMacPro1,1" \
-e SERIAL="C02TW0WAHX87" \
-e BOARD_SERIAL="C027251024NJG36UE" \
-e UUID="5CCB366D-9118-4C61-A00A-E5BAF3BED451" \
-e MAC_ADDRESS="A8:5C:2C:9A:46:2F" \
-e WIDTH=1000 \
-e HEIGHT=1000 \
sickcodes/docker-osx:naked
```
If you want to generate serial numbers, either make them at runtime using
` -e GENERATE_UNIQUE=true \`
Or you can generate them inside the `./custom` folder. And then use:
```bash
-e GENERATE_SPECIFIC=true \
-e SERIAL="" \
-e BOARD_SERIAL="" \
-e UUID="" \
-e MAC_ADDRESS="" \
```
#### Making serial numbers persist across reboots
```bash
stat mac_hdd_ng_testing.img
touch ./output.env
2021-03-09 16:06:35 -06:00
# generate fresh random serial numbers, with a screen, using your own image, and save env file with your new serial numbers for later.
docker run -it \
--device /dev/kvm \
-e "DISPLAY=${DISPLAY:-:0.0}" \
-v /tmp/.X11-unix:/tmp/.X11-unix \
-p 50922:10022 \
-e NOPICKER=true \
-e GENERATE_UNIQUE=true \
-e GENERATE_SPECIFIC=true \
-e DEVICE_MODEL="iMacPro1,1" \
-v "${PWD}/output.env:/env" \
-v "${PWD}/mac_hdd_ng_testing.img:/image" \
sickcodes/docker-osx:naked
```
To use iMessage or iCloud you need to change `5` values.
- `SERIAL`
- `BOARD_SERIAL`
- `UUID`
- `MAC_ADDRESS`
_`ROM` is just the lowercased mac address, without `:` between each word._
You can tell the container to generate them for you using `-e GENERATE_UNIQUE=true`
2021-03-15 06:39:17 -05:00
Or tell the container to use specific ones using `-e GENERATE_SPECIFIC=true`
```bash
-e GENERATE_SPECIFIC=true \
-e DEVICE_MODEL="iMacPro1,1" \
-e SERIAL="C02TW0WAHX87" \
-e BOARD_SERIAL="C027251024NJG36UE" \
-e UUID="5CCB366D-9118-4C61-A00A-E5BAF3BED451" \
-e MAC_ADDRESS="A8:5C:2C:9A:46:2F" \
```
#### How to obtain serial numbers
```bash
apt install libguestfs -y
pacman -S libguestfs
yum install libguestfs -y
```
Inside the `./custom` folder you will find `4` scripts.
- `config-nopicker-custom.plist`
- `opencore-image-ng.sh`
These two files are from OSX-KVM.
You don't need to touch these two files.
The config.plist has 5 values replaced with placeholders. [Click here to see those values for no reason.](https://github.com/sickcodes/Docker-OSX/blob/master/custom/config-nopicker-custom.plist#L705)
- `generate-unique-machine-values.sh`
This script will generate serial numbers, with Mac Addresses, plus output to CSV/TSV, plus make a `bootdisk image`.
You can create hundreds, `./custom/generate-unique-machine-values.sh --help`
```bash
./custom/generate-unique-machine-values.sh \
--count 1 \
--tsv ./serial.tsv \
--bootdisks \
--output-bootdisk OpenCore.qcow2 \
--output-env source.env.sh
```
Or if you have some specific serial numbers...
- `generate-specific-bootdisk.sh`
```bash
generate-specific-bootdisk.sh \
--model "${DEVICE_MODEL}" \
--serial "${SERIAL}" \
--board-serial "${BOARD_SERIAL}" \
--uuid "${UUID}" \
--mac-address "${MAC_ADDRESS}" \
--output-bootdisk OpenCore-nopicker.qcow2
```
# Change Resolution Docker-OSX - change resolution OpenCore OSX-KVM
The display resolution is controlled by this line:
https://github.com/sickcodes/Docker-OSX/blob/master/custom/config-nopicker-custom.plist#L819
Instead of mounting that disk, Docker-OSX will generate a new `OpenCore.qcow2` by using this one cool trick:
```bash
-e GENERATE_UNIQUE=true \
-e WIDTH=800 \
-e HEIGHT=600 \
```
To use `WIDTH`/`HEIGHT`, you must use with either `-e GENERATE_UNIQUE=true` or `-e GENERATE_SPECIFIC=true`.
It will take around 30 seconds longer to boot because it needs to make a new boot partition using `libguestfs`.
```bash
-e GENERATE_SPECIFIC=true \
-e WIDTH=1920 \
-e HEIGHT=1080 \
-e SERIAL="" \
-e BOARD_SERIAL="" \
-e UUID="" \
-e MAC_ADDRESS="" \
```
## Change Docker-OSX Resolution Examples
```bash
# using an image in your current directory
stat mac_hdd_ng.img
docker run -it \
--device /dev/kvm \
-p 50922:10022 \
-v "${PWD}/mac_hdd_ng.img:/image" \
-v /tmp/.X11-unix:/tmp/.X11-unix \
-e "DISPLAY=${DISPLAY:-:0.0}" \
-e GENERATE_SPECIFIC=true \
-e DEVICE_MODEL="iMacPro1,1" \
-e SERIAL="C02TW0WAHX87" \
-e BOARD_SERIAL="C027251024NJG36UE" \
-e UUID="5CCB366D-9118-4C61-A00A-E5BAF3BED451" \
-e MAC_ADDRESS="A8:5C:2C:9A:46:2F" \
-e MASTER_PLIST_URL=https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/custom/config-nopicker-custom.plist \
-e WIDTH=1600 \
-e HEIGHT=900 \
sickcodes/docker-osx:naked
```
```bash
# generating random serial numbers, using the DIY installer, along with the screen resolution changes.
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 WIDTH=800 \
-e HEIGHT=600 \
sickcodes/docker-osx:latest
```
Here's a few other resolutions! If you resolution is invalid, it will default to 800x600.
```
-e WIDTH=800 \
-e HEIGHT=600 \
```
```
-e WIDTH=1280 \
-e HEIGHT=768 \
```
```
-e WIDTH=1600 \
-e HEIGHT=900 \
```
```
-e WIDTH=1920 \
-e HEIGHT=1080 \
```
```
-e WIDTH=2560 \
-e HEIGHT=1600 \
```
### Mounting physical disks in Mac OS X
Pass the disk into the container as a volume and then pass the disk again into QEMU command line extras with.
Use the `config-custom.plist` because you probably want to see the boot menu, otherwise omit the first line:
```bash
DISK_TWO="${PWD}/mount_me.img"
```
```dockerfile
-e MASTER_PLIST_URL='https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-custom.plist' \
-v "${DISK_TWO}:/disktwo" \
-e EXTRA='-device ide-hd,bus=sata.5,drive=DISK-TWO -drive id=DISK-TWO,if=none,file=/disktwo,format=qcow2' \
```
### Example
```bash
OSX_IMAGE="${PWD}/mac_hdd_ng_xcode_bigsur.img"
DISK_TWO="${PWD}/mount_me.img"
docker run -it \
--device /dev/kvm \
-e "DISPLAY=${DISPLAY:-:0.0}" \
-v /tmp/.X11-unix:/tmp/.X11-unix \
-e MASTER_PLIST_URL='https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-custom.plist' \
-v "${OSX_IMAGE}":/image \
-v "${DISK_TWO}":/disktwo \
-e EXTRA='-device ide-hd,bus=sata.5,drive=DISK-TWO -drive id=DISK-TWO,if=none,file=/disktwo,format=qcow2' \
sickcodes/docker-osx:naked
```
### USB Passthrough
The simplest way to do this is the following:
First of all, in order to do this, QEMU must be started as root. It is also potentially possible to do this by changing the permissions of the device in the container.
See [here](https://www.linuxquestions.org/questions/slackware-14/qemu-usb-permissions-744557/#post3628691).
For example, create a new Dockerfile with the following
```bash
FROM sickcodes/docker-osx
USER arch
RUN sed -i -e s/exec\ qemu/exec\ sudo\ qemu/ ./Launch.sh
COPY --chown=arch ./new_image.img /home/arch/OSX-KVM/mac_hdd_ng.img
```
Where `new_image.img` is the qcow2 image you extracted. Then rebuild with `docker build .`
Find out the bus and port numbers of your USB device which you want to pass through to the VM.
```bash
lsusb -t
/: Bus 02.Port 1: Dev 1, Class=root_hub, Driver=xhci_hcd/6p, 5000M
/: Bus 01.Port 1: Dev 1, Class=root_hub, Driver=xhci_hcd/12p, 480M
|__ Port 2: Dev 5, If 0, Class=Human Interface Device, Driver=usbhid, 12M
|__ Port 2: Dev 5, If 1, Class=Chip/SmartCard, Driver=, 12M
|__ Port 3: Dev 2, If 0, Class=Wireless, Driver=, 12M
|__ Port 3: Dev 2, If 1, Class=Wireless, Driver=, 12M
|__ Port 5: Dev 3, If 0, Class=Video, Driver=uvcvideo, 480M
|__ Port 5: Dev 3, If 1, Class=Video, Driver=uvcvideo, 480M
```
In this example, we want to pass through a smartcard device. The device we want is on bus 1 and port 2.
There may also be differences if your device is usb 2.0 (ehci) vs usb 3.0 (xhci).
See [here](https://unix.stackexchange.com/a/452946/101044) for more details.
```bash
# hostbus and hostport correspond to the numbers from lsusb
# runs in privileged mode to enable access to the usb devices.
docker run \
--privileged \
--device /dev/kvm \
-e RAM=4 \
-p 50922:10022 \
-e "DISPLAY=${DISPLAY:-:0.0}" \
-e EXTRA="-device virtio-serial-pci -device usb-host,hostbus=1,hostport=2" \
mycustomimage
```
You should see the device show up when you do `system_profiler SPUSBDataType` in the MacOS shell.
2020-12-16 12:24:57 -06:00
Important Note: this will cause the host system to lose access to the USB device while the VM is running!
#### What is `${DISPLAY:-:0.0}`?
`$DISPLAY` is the shell variable that refers to your X11 display server.
`${DISPLAY}` is the same, but allows you to join variables like this:
- e.g. `${DISPLAY}_${DISPLAY}` would print `:0.0_:0.0`
- e.g. `$DISPLAY_$DISPLAY` would print `:0.0`
...because `$DISPLAY_` is not `$DISPLAY`
`${variable:-fallback}` allows you to set a "fallback" variable to be substituted if `$variable` is not set.
You can also use `${variable:=fallback}` to set that variable (in your current terminal).
In Docker-OSX, we assume, `:0.0` is your default `$DISPLAY` variable.
You can see what yours is
```bash
echo $DISPLAY
```
That way, `${DISPLAY:-:0.0}` will use whatever variable your X11 server has set for you, else `:0.0`
#### What is `-v /tmp/.X11-unix:/tmp/.X11-unix`?
`-v` is a Docker command-line option that lets you pass a volume to the container.
The directory that we are letting the Docker container use is a X server display socket.
`/tmp/.X11-unix`
If we let the Docker container use the same display socket as our own environment, then any applications you run inside the Docker container will show up on your screen too! [https://www.x.org/archive/X11R6.8.0/doc/RELNOTES5.html](https://www.x.org/archive/X11R6.8.0/doc/RELNOTES5.html)