Skip to content

Document Docker usage in README (closes #9) #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bryanroscoe merged 2 commits into from
May 8, 2026
Merged

Document Docker usage in README (closes #9) #13

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a318054
Document Docker usage for Linux
bryanroscoe May 8, 2026
435c511
Note Docker workflow is not yet verified end-to-end
bryanroscoe May 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,24 @@ sudo apt-get install -y powershell
pwsh ./Shield-Optimizer.ps1
```

### Linux (Docker)

> *Should work, but not verified end-to-end.* Based on the workflow @shawly reported in [#9](https://github.com/bryanroscoe/shield_optimizer/issues/9).

If you'd rather not install PowerShell on your host, you can run the script inside Microsoft's official PowerShell container. `--network host` is required so the script can scan your LAN for devices, and `iproute2` is needed inside the container for the auto-discovery scan.

```bash
# Start an interactive PowerShell container on the host network
docker run -it --rm --network host mcr.microsoft.com/powershell:latest

# Inside the container:
apt-get update && apt-get install -y iproute2
Invoke-WebRequest -Uri https://github.com/bryanroscoe/shield_optimizer/raw/refs/heads/main/Shield-Optimizer.ps1 -OutFile Shield-Optimizer.ps1
./Shield-Optimizer.ps1
```

> **Note:** `--network host` only works on native Linux. On Docker Desktop for macOS/Windows, auto-discovery won't see your LAN — install PowerShell natively (see above) or use the script's **Connect IP** option to enter your device's IP manually.

## Download

**Option 1: Download from Releases (Recommended)**
Expand Down