Prerequisites
Before installing the extension, ensure you have:- Chrome browser (version 88 or later)
- Built extension files (see Installation for build instructions)
- Tracker server running and accessible
Installation steps
Open Chrome extensions page
Navigate to
chrome://extensions in your Chrome browser. You can either:- Type
chrome://extensionsdirectly in the address bar, or - Click the three-dot menu → More Tools → Extensions
Enable developer mode
Toggle the Developer mode switch in the top-right corner of the extensions page. This reveals additional options for loading unpacked extensions.
Load the extension
Click the Load unpacked button that appears in the top-left corner after enabling developer mode.In the file picker dialog, navigate to your email tracker repository and select the
extension/ directory.The extension directory contains:manifest.json- Extension configurationsrc/- Extension source codebackground/serviceWorker.js- Background service workercontent/gmailCompose.js- Gmail content scriptpopup/- Extension popup UI
Permissions explained
The extension requests the following permissions inextension/manifest.json:6-7:
- storage: Stores user ID, tracker configuration, and recent email metadata
- host_permissions:
https://mail.google.com/*- Access Gmail to inject tracking pixels and display badgeshttp://*/*andhttps://*/*- Communicate with your self-hosted tracker server
Updating the extension
When you make changes to the extension code:- Navigate to
chrome://extensions - Find the Gmail Email Tracker extension card
- Click the circular Reload icon
Troubleshooting
Extension doesn’t appear after loading
- Verify you selected the correct
extension/directory containingmanifest.json - Check the Chrome extensions page for error messages under the extension card
- Ensure all required files are present in the
extension/directory
Permission warnings
Chrome may display warnings about the extension’s broad host permissions. This is expected since the extension needs to:- Access Gmail to inject pixels
- Connect to your self-hosted tracker server (which can be any HTTP/HTTPS URL)
Next steps
After installing the extension:- Configure the extension with your tracker base URL and dashboard token
- Start using the extension to track emails in Gmail