Aw watcher web
Browser watcher for ActivityWatch
A cross-browser WebExtension that serves as a web browser watcher for [ActivityWatch][activitywatch]. The project is written primarily in TypeScript, distributed under the Mozilla Public License 2.0 license, first published in 2017. Key topics include: activitywatch, chrome-extension, firefox-extension, quantified-self, time-tracker.
aw-watcher-web
A cross-browser WebExtension that serves as a web browser watcher for ActivityWatch.
Installation
Official Releases
Install from official stores:
Development Build
Download the latest development build from our GitHub Actions:
- Click on the latest successful workflow run
- Scroll down to "Artifacts"
- Download either
firefox.ziporchrome.zip
[!NOTE]
- GitHub login is required to download artifacts
- These builds are unsigned and require developer mode/settings
Firefox Enterprise Policy
[!NOTE]
Due to Mozilla Add-on Policy, this is not possible with the Mozilla-hosted versions of the extension. You will need to fork the extension and change a hardcoded value to make this work.
Due to the above issue, a privacy notice must be displayed to comply with the Mozilla Add-on Policy. This can be pre-accepted by setting the following Firefox Enterprise Policy (More about Firefox Policies):
json{ "policies": { "3rdparty": { "Extensions": { "{ef87d84c-2127-493f-b952-5b4e744245bc}": { "consentOfflineDataCollection": true } } } } }
Building from Source
Prerequisites
- Node.js (23 or higher)
- Git
- Make
Build Steps
- Clone the repository with submodules:
shgit clone --recurse-submodules https://github.com/ActivityWatch/aw-watcher-web.git cd aw-watcher-web
- Install dependencies:
shmake install
- Build the extension:
sh# For Firefox: make build-firefox # For Chrome: make build-chrome
This will create zip files in the artifacts directory:
artifacts/firefox.zipfor Firefoxartifacts/chrome.zipfor Chrome
if you want to build safari version
- First follow the steps above to build the extension:
shmake install make build-safari
- Convert the extension to Safari format:
shxcrun safari-web-extension-converter ./build
after finished, xcode will open automatically.
- In Xcode:
- Select build target of macOS
- Build the project (⌘B)
- Run the extension (⌘R)
- Enable the extension in Safari:
- Open Safari
- Go to Safari > Settings > Extensions
- Enable "aw-watcher-web"
[!NOTE]
- You need Xcode installed to build Safari extensions
- The extension needs to be signed with your Apple Developer account
- Safari extensions require macOS 11.0 or later
Installing the Development Build
Chrome
- Extract
artifacts/chrome.zipto a folder - Go to
chrome://extensions - Enable "Developer mode"
- Click "Load unpacked" and select the extracted folder
Firefox
- Go to
about:addons - Click the gear icon (⚙️) and select "Install Add-on From File..."
- Navigate to and select the
artifacts/firefox.zipfile
[!NOTE]
For Firefox, installing unsigned extensions requires Firefox Developer Edition or Nightly.
In Firefox Developer Edition, you need to setxpinstall.signatures.requiredtofalseinabout:config.
Contributors
Showing top 12 contributors by commit count.
