Requirements
- macOS 13.0 (Ventura) or later
- Apple Silicon (M1/M2/M3/M4) or Intel Mac
- Admin access (for extension approval)
Installation
Option 1: Download DMG (Recommended)
- Download
OISP.dmgfrom the releases page - Open the DMG and drag OISP to Applications
- Open OISP from Applications
- Follow the setup wizard
Option 2: Build from Source
Setup
1. Approve Network Extension
When you first launch OISP, macOS will prompt you to allow the Network Extension:- Click “Open System Settings” when prompted
- Go to Privacy & Security → Network Extensions
- Toggle OISP Network Extension to Allow
This requires admin authentication. The extension intercepts network traffic to AI provider domains only.
2. Trust CA Certificate
OISP uses a local Certificate Authority to decrypt HTTPS traffic:- Click “Install CA Certificate” in the OISP menu bar app
- Enter your admin password when prompted
- The certificate is added to System Keychain
3. Start Capture
- Click the OISP icon in the menu bar
- Click “Start Capture”
- AI traffic will now be captured
Verify Installation
Check Extension Status
com.oisp.networkextension with status enabled_active.
Check CA Certificate
Open Keychain Access and search for “OISP”. You should see the OISP CA certificate marked as trusted.Test Capture
Make an API call and check the web UI:Uninstallation
1. Remove Extension
- Open System Settings → Privacy & Security → Network Extensions
- Toggle OISP Network Extension to off
- Or run:
systemextensionsctl uninstall com.oisp.networkextension
2. Remove CA Certificate
- Open Keychain Access
- Search for “OISP”
- Delete the OISP CA certificate
3. Remove App
- Quit OISP from the menu bar
- Drag OISP from Applications to Trash
Troubleshooting
Extension won’t load
- Check System Settings → Privacy & Security → Network Extensions
- Ensure OISP is allowed
- Try restarting your Mac
Certificate errors
- Verify the CA is in System Keychain (not login keychain)
- Check it’s marked as “Always Trust”
- Restart browser/application after trusting
No events captured
- Check the extension is running:
systemextensionsctl list - Verify capture is started in menu bar app
- Run with debug:
RUST_LOG=debug /path/to/oisp-sensor
Next Steps
- Quick Start — Capture your first events
- Overview — Understand the architecture