Improve macOS Apple Silicon install flow (Colima/Docker Desktop)#1
Open
piartz wants to merge 10 commits intoBugTraceAI:mainfrom
Open
Improve macOS Apple Silicon install flow (Colima/Docker Desktop)#1piartz wants to merge 10 commits intoBugTraceAI:mainfrom
piartz wants to merge 10 commits intoBugTraceAI:mainfrom
Conversation
Removed regression risk section for non-macOS users from README.
There was a problem hiding this comment.
Pull request overview
This PR improves the macOS (Apple Silicon) first-time install and runtime flow by enhancing installer bootstrapping, adding macOS runtime helpers (Docker Desktop/Colima), and hardening optional MCP deployments (reconFTW/Kali) to avoid common ARM-related failures.
Changes:
- Reworked
install.shto be user-target aware and support macOS dependency bootstrapping via Homebrew. - Extended
launcher.shwith macOS runtime preparation (PATH/compose detection/daemon wait) and Colima/Docker Desktop bring-up helpers. - Added reconFTW/Kali MCP “compat patch” hooks (platform pinning, venv/entrypoint patches, startup command rewrite, SSE defaulting, and longer health timeouts on ARM).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
launcher.sh |
Adds macOS runtime bootstrap helpers and applies MCP compatibility patches for reconFTW/Kali on ARM/macOS. |
install.sh |
Updates one-liner bootstrap to run as the target user, install prerequisites, clone/update launcher, and hand off to the wizard. |
README.md |
Updates quick-start and macOS guidance to reflect Docker Desktop vs Colima and new bootstrap behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+355
to
+362
| ensure_macos_docker_path() { | ||
| for p in "$HOME/.docker/bin" "/usr/local/bin" "/opt/homebrew/bin"; do | ||
| if [[ -x "$p/docker" ]]; then | ||
| export PATH="$p:$PATH" | ||
| fi | ||
| done | ||
| hash -r | ||
| } |
| return 1 | ||
| fi | ||
| info "Installing Docker Desktop..." | ||
| brew install --cask docker |
| return 1 | ||
| fi | ||
|
|
||
| ensure_macos_brew_packages docker docker-compose colima qemu lima-additional-guestagents |
Comment on lines
+232
to
+245
| BEGIN { in_kali=0; in_cmd=0 } | ||
| /^ kali-mcp:[[:space:]]*$/ { in_kali=1; print; next } | ||
| in_kali && /^ [^[:space:]]/ { in_kali=0 } | ||
| in_kali && /^[[:space:]]+command:[[:space:]]*>[[:space:]]*$/ { | ||
| in_cmd=1 | ||
| print " command: >" | ||
| print " bash -lc \"set -e; echo '\''Waiting for network initialization...'\''; sleep 5; apt-get update; DEBIAN_FRONTEND=noninteractive apt-get install -y nmap ffuf nuclei sqlmap dirb gobuster nikto hydra john hashcat curl wget netcat-openbsd python3 python3-pip git vim; command -v nmap hydra python3 >/dev/null; echo '\''Kali MCP Server ready!'\''; tail -f /dev/null\"" | ||
| next | ||
| } | ||
| in_cmd { | ||
| if (in_kali && /^[[:space:]]+(extra_hosts:|restart:|networks:|ports:|volumes:|environment:|cap_add:|security_opt:|profiles:|container_name:|image:)/) { | ||
| in_cmd=0 | ||
| } |
| info "Checking system requirements..." | ||
| echo "" | ||
| TARGET_USER="${SUDO_USER:-$USER}" | ||
| TARGET_HOME="$(eval echo "~$TARGET_USER")" |
|
|
||
| chmod +x "$LAUNCHER_DIR/launcher.sh" | ||
| info "Cloning BugTraceAI Launcher into $LAUNCHER_DIR..." | ||
| mkdir -p "$(dirname "$LAUNCHER_DIR")" |
|
|
||
| fix_permissions_if_needed() { | ||
| if [[ $EUID -eq 0 ]] && [[ -n "${SUDO_USER:-}" ]]; then | ||
| chown -R "$TARGET_USER":"$TARGET_USER" "$LAUNCHER_DIR" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves first-time installation on macOS (Apple Silicon in particular) while preserving the existing launcher workflow.
Key goals:
What changed
Installer bootstrap (
install.sh)SUDO_USER) instead of forcing root-only behavior.Launcher runtime compatibility (
launcher.sh)x86_64Colima profile on arm64 hostaarch64) to prevent image format failureshelp/status/...) so/dev/ttyerrors do not occur in command mode.LC_ALL=Cfor/dev/urandomfiltering.Setup robustness improvements
reconFTW and Kali deployment hardening
reconFTW MCP fixes applied
linux/amd64for reconFTW service on ARM hosts.FROM --platform=linux/amd64 ...on ARM.virtualenvifensurepipfails./sse).reconftw.shreconftw/install.shby default unlessRECONFTW_AUTO_INSTALL=trueRECONFTW_AUTO_INSTALL=falsein WEB compose recon service environment.Kali MCP fixes applied
bash -lcstartup command (avoids multiline parsing issues).nmap,hydra,python3) after install.Docs (
README.md)Validation done locally (macOS Apple Silicon)
Executed clean install tests in isolated target directory:
BUGTRACEAI_DIR=/Users/mperezrodriguez/bugtraceai/_fresh_install ./launcher.shSyntax checks:
bash -n install.shbash -n launcher.shRegression risk assessment
Notes