Skip to content

Commit c24ca26

Browse files
committed
Clarify macOS install limitations
- Skip Docker/kind setup on macOS in install.sh - Note Linux-only Docker/kind support in docs - Add macOS TFTP server availability note
1 parent 5180690 commit c24ca26

6 files changed

Lines changed: 1091 additions & 4 deletions

File tree

docs/docker/install.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# PyPNM Docker Install & Usage
22

3+
Note: Docker workflows are supported on Linux hosts. macOS users should not use
4+
these Docker-specific instructions.
5+
36
PyPNM ships with Docker assets so you can run the API quickly on a workstation, lab host, or VM. This guide covers the common flows:
47

58
- Install the published release image via the helper script.

docs/install/development.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Development Install (Docker + kind)
22

3+
Note: Docker and Kubernetes workflows are supported on Linux. macOS users should not use
4+
the Docker/kind paths in this guide.
5+
36
Use this when you want a local environment that can run the release smoke tests.
47

58
This option installs:

docs/kubernetes/pypnm-deploy.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# PyPNM on Kubernetes (kind)
22

3+
Note: Kubernetes (kind) workflows are supported on Linux hosts. macOS users should not
4+
use this guide.
5+
36
This walkthrough uses the manifests in `deploy/kubernetes/`. Start by installing kind and creating a cluster using [Local Kubernetes (kind) install](kind-install.md).
47

58
## Repo toolkit usage (recommended)

docs/system/pnm-file-retrieval/tftp.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,9 @@ If PNM file retrieval fails with TFTP errors (for example,
6868
`TFTP_PNM_FILE_FETCH_ERROR` in the logs), verify:
6969

7070
1. The TFTP service is running on `localhost` and listening on UDP port 69.
71+
72+
Note: macOS includes a TFTP client but does not ship a native TFTP server. Use a
73+
third-party daemon if you need a local TFTP server on macOS.
7174
2. The TFTP server is allowed to **serve** files (download) as well as accept
7275
uploads from the cable modem. Some configurations are upload-only.
7376
3. The TFTP root or `remote_dir` actually contains the PNM files that the CM

install.sh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -462,6 +462,11 @@ esac
462462

463463
if [[ "$DEVELOPMENT_MODE" == "1" ]]; then
464464
echo "🧰 Development setup: Docker + kind/kubectl + gitleaks..."
465+
if [[ "$PM" == "brew" ]]; then
466+
echo "⚠️ macOS does not support the Docker/kind bootstrap in this script."
467+
echo " Skipping Docker/kind install; running gitleaks setup only."
468+
install_gitleaks
469+
else
465470
if ! command -v curl >/dev/null 2>&1; then
466471
if [[ "$PM" == "none" ]]; then
467472
echo "❌ curl not found and no package manager available."
@@ -488,6 +493,7 @@ if [[ "$DEVELOPMENT_MODE" == "1" ]]; then
488493
install_gitleaks
489494
echo "ℹ️ Docker may require: sudo systemctl start docker"
490495
echo "ℹ️ For non-sudo Docker: sudo usermod -aG docker \"${USER}\" (then log out/in)"
496+
fi
491497
fi
492498

493499
if ! command -v python3 >/dev/null 2>&1; then

0 commit comments

Comments
 (0)