Repository navigation
Engineering macos installation
KeepPeek releases for macOS support Apple Silicon (arm64) only.
Download the keeppeek-<version>-macos-aarch64.dmg release asset and its
matching .sha256 file. Verify its checksum:
shasum -a 256 -c keeppeek-<version>-macos-aarch64.dmg.sha256Open the disk image and drag KeepPeek.app to Applications. Open KeepPeek
from Applications once to install and start its service.
KeepPeek installs a per-user launchd service. It starts automatically after
you log in and restarts after an unsuccessful exit. It uses the configuration
and recordings under ~/Library/Application Support/keeppeek.
To check the service and follow its logs, run:
launchctl print gui/"$(id -u)"/com.keeppeek
tail -f ~/Library/Logs/KeepPeek/keeppeek.log ~/Library/Logs/KeepPeek/keeppeek-error.logTo stop and remove the service and application:
launchctl bootout gui/"$(id -u)"/com.keeppeek
rm -f ~/Library/LaunchAgents/com.keeppeek.plist
rm -rf /Applications/KeepPeek.appDragging a newer KeepPeek.app to Applications replaces the existing
application. Open it once afterward to restart the service using the updated
version.
macOS DMGs are unsigned unless the release workflow is configured with all three of these GitHub Actions secrets:
-
MACOS_SIGNING_CERTIFICATE_BASE64: Base64-encoded Developer ID Application PKCS#12 certificate. -
MACOS_SIGNING_CERTIFICATE_PASSWORD: Password for that certificate. -
MACOS_SIGNING_IDENTITY: The certificate's codesigning identity.
When present, the workflow signs the application before creating the DMG.
To submit the signed DMG for notarization and staple the resulting ticket, also configure these secrets:
-
MACOS_NOTARIZATION_APPLE_ID: Apple ID used for notarization. -
MACOS_NOTARIZATION_PASSWORD: App-specific password for that Apple ID. -
MACOS_NOTARIZATION_TEAM_ID: Apple Developer team identifier.
- KeepPeek
- Feature guide and navigation
- Get started
- Authentication and access control
- Camera controls
- Demo videos
- Live wall and kiosk display
- Recording and evidence
- Digital zoom and pan
- Camera and stream health
- Visual configuration management
- Configuration reference
- Export and import configuration
- Backup and restore
- Upgrades and migrations
- Recording maintenance
- Recording archive recovery
- Native camera events
- External analysis
- Notifications and integrations
- Home Assistant card
- Groups and two-way audio: current status
- How KeepPeek works
- Users and design choices
- Release readiness and known limitations
- Reporting bugs
- Open source and licensing
- Contributing
- Access control
- Backup and restore
- Camera controls and vendor alignment
- Computer Vision Service Scenario
- Visual configuration management
- Demo Video Publishing
- MQTT 5 Event Forwarder
- Event-Loop Runtime
- Event presentation metadata
- Event browsing, search, and encoded previews
- Event Review and Shared Bookmarks
- Evidence exports
- External authentication proposal
- Operate external authentication
- External authentication performance evidence
- External authentication verification
- Group Client Scenarios
- Hikvision ISAPI integration notes
- Home Assistant Card
- macOS installation
- Native event recording performance
- Notification rules and delivery
- Native event acceptance evidence
- Generic ONVIF and RTSP events
- Performance benchmarks
- Event pre-recording contract proposal
- Event pre-recording performance qualification
- Event pre-recording acceptance evidence
- Pushover notifications
- Recording integrity
- Recording policy audit
- Runtime profiles implementation contract
- Secrets configuration
- Shared State Store Scenario
- Transcoding Service Scenario
- Viewer Application Scenario
- Wiki publishing
- Windows service