Add macOS installer script and installation guide - #17
Open
divyanshus2404 wants to merge 1 commit into
Open
divyanshus2404 wants to merge 1 commit into
divyanshus2404 wants to merge 1 commit into
Conversation
divyanshus2404
force-pushed
the
feature/macos-installer
branch
from
September 13, 2026 05:49
2ec8564 to
fbcf46b
Compare
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.
What this does
PlumoAI already runs on macOS through
install.sh, but there is no macOS entry point equivalent toinstall.ps1on Windows, anddocs/has no macOS page. This adds both.Two files
PlumoAI-Installer.command- a double-clickable bootstrapper, the macOS counterpart toPlumoAISetup.exe. A user downloads it, double-clicks (right-click - Open the first time to clear the Gatekeeper warning), and PlumoAI installs with no command line. It uses an adjacent checkout when shipped inside the repo, otherwise git-clones into~/PlumoAI, then runsinstall-macos.sh- falling back toinstall.shdirectly ifinstall-macos.shis not present in the fetched version, so it works even before this PR merges.install-macos.shis a thin wrapper (below) that prepares a Mac and then hands off toinstall.sh, rather than duplicating any of its logic:install.shuses--freshand--no-backupstraight through toinstall.shThere is also a
--checkflag that reports what would happen without installing or starting anything, so it is safe to run before committing to an install:Portability
Written against the bash 3.2 that ships with macOS, so it avoids bash 4+ syntax (
declare -A,mapfile, parameter-case expansion) and GNU-only flags (sed -i,readlink -f,base64 -w). It runs on a stock system with nothing installed beyond the Xcode Command Line Tools.Testing
Verified on macOS 26.6.2 (arm64):
/bin/bash3.2shellcheck--checkon a machine without Docker--helpThe URL parsing was exercised separately across six cases: localhost with default port, localhost with a custom port, domain mode, quoted values, missing port (falls back to 7861), and domain mode with an empty domain (falls back to localhost). All six resolve correctly.
Verified end to end on macOS 26.6.2 (arm64). Docker Desktop 4.90.0 was installed fresh, then
./install-macos.shwas run start to finish:All 8 images pulled, all 8 containers started:
http://localhost:7861returns HTTP 200 and serves the login page.Two things found while testing
install.shis not executable in the repo (100644), so the README's./install.shfails withPermission denieduntil youchmod +x. This wrapper does it automatically, but the repo file itself is worth fixing..env.exampleships withRUN_MODE=domain, so any non-interactive run stops atError: For domain mode, DOMAIN_NAME and SSL_EMAIL must be set in .env.localhostwould be a safer default for a first run.Docs
docs/install-macos.mdcovers the quick install, the manual equivalent, the flag reference, stack management commands, and troubleshooting for the failure modes specific to macOS (daemon not running, port conflicts, the first-launch privileged helper prompt, Rosetta image warnings).Note that
docs/install-linux.mdanddocs/install-windows.mdare currently empty placeholder files. This PR does not touch them, but they are a visible gap if anyone follows the links.