Skip to content

Commit 0e26070

Browse files
authored
🤖 Update docs: macOS DMGs are now signed and notarized (#98)
Simplified installation instructions now that proper code signing and notarization are in place (from #90). ## Changes - **docs/install.md**: Removed all Gatekeeper bypass instructions (right-click → Open, terminal workarounds) - **docs/install.md**: Clarified separate x64 and arm64 artifact names - **README.md**: Updated to note signed/notarized status ## User Impact Users can now install cmux on macOS without any security warnings or workarounds. The app opens normally like any other Mac application. _Generated with `cmux`_
1 parent eddee9b commit 0e26070

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ A cross-platform desktop application for embarassingly parallel development.
1919

2020
Download pre-built binaries from [GitHub Actions artifacts](https://github.com/coder/cmux/actions/workflows/build.yml):
2121

22-
- **macOS**: Universal binary DMG (Intel + Apple Silicon)
22+
- **macOS**: Signed and notarized DMG (separate builds for Intel/Apple Silicon)
2323
- **Linux**: AppImage
2424

2525
## Development

docs/install.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,42 +6,42 @@
66

77
Pre-built binaries are available from [GitHub Actions](https://github.com/coder/cmux/actions/workflows/build.yml):
88

9-
- **macOS**: Universal binary DMG (Intel + Apple Silicon)
9+
- **macOS**: Signed and notarized DMG
10+
- `macos-dmg-x64` (Intel Macs)
11+
- `macos-dmg-arm64` (Apple Silicon)
1012
- **Linux**: AppImage (portable, works on most distros)
1113

1214
To download:
1315

1416
1. Go to the [Build workflow](https://github.com/coder/cmux/actions/workflows/build.yml)
1517
2. Click on the latest successful run
1618
3. Scroll down to "Artifacts" section
17-
4. Download `macos-dmg` or `linux-appimage`
19+
4. Download the appropriate artifact for your platform
1820

1921
### Installation
2022

2123
**macOS:**
2224

23-
⚠️ **Note**: The app is unsigned, so you'll need to bypass Gatekeeper security.
25+
1. Download the DMG file for your Mac:
26+
- Intel Mac: `macos-dmg-x64`
27+
- Apple Silicon: `macos-dmg-arm64`
28+
2. Open the DMG file
29+
3. Drag Cmux to Applications folder
30+
4. Open the app normally
2431

25-
1. Download and open the DMG file
26-
2. Drag Cmux to Applications folder
27-
3. **First time opening**:
28-
- Don't double-click the app (macOS will block it)
29-
- Right-click (or Control+click) on Cmux.app
30-
- Select "Open" from the menu
31-
- Click "Open" in the security dialog
32-
- The app will now be allowed to run
33-
34-
**Alternative method if the above doesn't work:**
35-
36-
1. After step 2, open Terminal
37-
2. Run: `xattr -cr /Applications/Cmux.app`
38-
3. Run: `codesign --force --deep --sign - /Applications/Cmux.app`
39-
4. Now you can open the app normally
40-
41-
These steps are only needed once. After that, you can open the app normally.
32+
The app is code-signed and notarized by Apple, so it will open without security warnings.
4233

4334
**Linux:**
4435

4536
1. Download the AppImage file
4637
2. Make it executable: `chmod +x Cmux-*.AppImage`
4738
3. Run it: `./Cmux-*.AppImage`
39+
40+
### Testing Pre-Release Builds
41+
42+
⚠️ **Note**: Only builds from the `main` branch are signed and notarized. If you're testing a build from a pull request or other branch, you'll need to bypass macOS Gatekeeper:
43+
44+
1. After installing, open Terminal
45+
2. Run: `xattr -cr /Applications/Cmux.app`
46+
3. Run: `codesign --force --deep --sign - /Applications/Cmux.app`
47+
4. Now you can open the app normally

0 commit comments

Comments
 (0)