From 6d65c6cfbb4df51eca992455590390c6d67e2113 Mon Sep 17 00:00:00 2001 From: Kroese Date: Tue, 18 Mar 2025 14:15:12 +0100 Subject: [PATCH] docs: Github Codespaces (#217) --- readme.md | 21 +++++++++++++-------- src/entry.sh | 1 + 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/readme.md b/readme.md index e498cd2..2f12e82 100644 --- a/readme.md +++ b/readme.md @@ -22,7 +22,7 @@ OSX (macOS) inside a Docker container. ## Usage 🐳 -Via Docker Compose: +##### Via Docker Compose: ```yaml services: @@ -46,27 +46,32 @@ services: stop_grace_period: 2m ``` -Via Docker CLI: +##### Via Docker CLI: ```bash docker run -it --rm --name macos -p 8006:8006 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN -v ${PWD:-.}/macos:/storage --stop-timeout 120 dockurr/macos ``` -Via Kubernetes: +##### Via Kubernetes: ```shell kubectl apply -f https://raw.githubusercontent.com/dockur/macos/refs/heads/master/kubernetes.yml ``` +##### Via Github Codespaces: + +[`Click here to launch this container in the cloud!`](https://github.com/codespaces/new?skip_quickstart=true&machine=basicLinux32gb&repo=809475352&ref=master&devcontainer_path=.devcontainer.json) + ## Compatibility ⚙️ | **Product** | **Platform** | | |---|---|---| -| Docker Engine | Linux| ✅ | -| Docker Desktop | Linux | ❌ | -| Docker Desktop | macOS | ❌ | -| Docker Desktop | Windows 11 | ✅ | -| Docker Desktop | Windows 10 | ❌ | +| Docker Engine | Linux | ✅ | +| Docker Desktop | Linux | ❌ | +| Docker Desktop | macOS | ❌ | +| Docker Desktop | Windows 11 | ✅ | +| Docker Desktop | Windows 10 | ❌ | +| Github Codespaces | Cloud | ✅ | ## FAQ 💬 diff --git a/src/entry.sh b/src/entry.sh index 6b204af..ea45b8b 100644 --- a/src/entry.sh +++ b/src/entry.sh @@ -8,6 +8,7 @@ set -Eeuo pipefail cd /run +. utils.sh # Load functions . reset.sh # Initialize system . install.sh # Get the OSX images . disk.sh # Initialize disks