Skip to content

Commit d317d7e

Browse files
authored
Merge pull request #160 from thawn/copilot/add-docs-unsigned-executables
Document unsigned executable warnings for macOS and Windows
2 parents 6dcf1f9 + 31acea4 commit d317d7e

File tree

3 files changed

+21
-3
lines changed

3 files changed

+21
-3
lines changed

docs/building-executables.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,19 @@ Or double-click the app bundle in Finder.
115115

116116
**Bundled binaries not found**: Verify `lib/` directory structure in spec files
117117

118-
**macOS Gatekeeper issues**: Users must right-click → Open first time. For distribution, sign and notarize with Apple Developer certificate.
118+
**macOS Gatekeeper issues**: Users must right-click → Open first time ([bypass instructions](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac))
119+
120+
**Windows SmartScreen issues**: Users must click "More info" → "Run anyway" ([bypass instructions](https://support.microsoft.com/en-us/windows/what-is-smartscreen-and-how-can-it-help-protect-me-1c9a874a-6826-be5e-45b1-67fa445a74c8))
121+
122+
## Code Signing
123+
124+
The distributed executables are **not code-signed** as code signing certificates are not available. This causes security warnings on macOS and Windows:
125+
- **macOS**: Gatekeeper warning - users must right-click → Open
126+
- **Windows**: SmartScreen warning - users must click "More info" → "Run anyway"
127+
128+
To sign executables for distribution, you would need:
129+
- **macOS**: Apple Developer account and notarization ($99/year)
130+
- **Windows**: Code signing certificate from trusted CA ($100-400/year)
119131

120132
## Notes
121133

docs/installation.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
Download pre-built executables from [releases page](https://github.com/thawn/ttmp32gme/releases), extract, and run. Open `http://localhost:10020` in browser.
66

7+
**⚠️ Security Warning**: The executables are unsigned as code signing certificates are not available. Your OS will show security warnings on first run.
8+
79
**Requirements**:
810
- Chrome or Chromium browser (optional, for PDF generation) - [Download Chrome](https://www.google.com/chrome/)
911
- Note: Chromium is only needed if printing directly from your browser doesn't work. You can print control sheets directly from most browsers without Chromium.
@@ -14,8 +16,10 @@ Download pre-built executables from [releases page](https://github.com/thawn/ttm
1416
- `ttmp32gme-macos.zip` for macOS
1517
2. Extract the ZIP file to a location of your choice
1618
3. Run the executable:
17-
- Windows: Double-click `ttmp32gme.exe` or run from command prompt
18-
- macOS: Right-click `ttmp32gme.app` → Open (first time only to bypass Gatekeeper)
19+
- **Windows**: Double-click `ttmp32gme.exe` or run from command prompt
20+
- If Windows SmartScreen blocks it: Click "More info" → "Run anyway" ([details](https://support.microsoft.com/en-us/windows/what-is-smartscreen-and-how-can-it-help-protect-me-1c9a874a-6826-be5e-45b1-67fa445a74c8))
21+
- **macOS**: Right-click `ttmp32gme.app` → "Open" (first time only to bypass Gatekeeper)
22+
- If blocked: System Settings → Privacy & Security → scroll down → "Open Anyway" ([details](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac))
1923
4. Open your browser to `http://localhost:10020`
2024

2125
The executable includes all necessary dependencies (tttool, ffmpeg) except Chrome/Chromium which should be installed separately.

docs/troubleshooting.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## Installation
44

5+
**Security warnings (Windows/macOS executables)**: The executables are unsigned. Windows SmartScreen: Click "More info" → "Run anyway". macOS Gatekeeper: Right-click → "Open", or System Settings → Privacy & Security → "Open Anyway". See [Installation](installation.md) for details.
6+
57
**Python version error**: Use Python 3.11+ (`python3.11 -m pip install -e .` or `uv pip install -e .`)
68

79
**tttool not found**: Install tttool ([instructions](installation.md)), check PATH

0 commit comments

Comments
 (0)