https://github.com/ActivityWatch/aw-watcher-web
Browser watcher for ActivityWatch
https://github.com/ActivityWatch/aw-watcher-web
activitywatch chrome-extension firefox-extension quantified-self time-tracker webextension
Last synced: 23 days ago
JSON representation
Browser watcher for ActivityWatch
- Host: GitHub
- URL: https://github.com/ActivityWatch/aw-watcher-web
- Owner: ActivityWatch
- License: mpl-2.0
- Created: 2017-01-16T13:06:56.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-26T17:19:27.000Z (7 months ago)
- Last Synced: 2024-10-30T00:54:48.678Z (6 months ago)
- Topics: activitywatch, chrome-extension, firefox-extension, quantified-self, time-tracker, webextension
- Language: JavaScript
- Homepage:
- Size: 249 KB
- Stars: 324
- Watchers: 10
- Forks: 46
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-activitywatch - aw-watcher-web - Official browser extension for Chrome, Edge, and Firefox (Browser Watchers :globe_with_meridians:)
README
# aw-watcher-web
[][chrome]
[][firefox]
A cross-browser WebExtension that serves as a web browser watcher for [ActivityWatch][activitywatch].
## Installation
### Official Releases
Install from official stores:
- [Chrome Web Store][chrome]
- [Firefox Add-ons][firefox]
### Development Build
Download the latest development build from our [GitHub Actions][gh-actions]:
1. Click on the latest successful workflow run
2. Scroll down to "Artifacts"
3. Download either `firefox.zip` or `chrome.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][mozilla-policy]):
```json
{
"policies": {
"3rdparty": {
"Extensions": {
"{ef87d84c-2127-493f-b952-5b4e744245bc}": {
"consentOfflineDataCollection": true
}
}
}
}
}
```
## Building from Source
### Prerequisites
- Node.js (23 or higher)
- Git
- Make
### Build Steps
1. Clone the repository with submodules:
```sh
git clone --recurse-submodules https://github.com/ActivityWatch/aw-watcher-web.git
cd aw-watcher-web
```
2. Install dependencies:
```sh
make install
```
3. 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.zip` for Firefox
- `artifacts/chrome.zip` for Chrome
### Installing the Development Build
#### Chrome
1. Extract `artifacts/chrome.zip` to a folder
2. Go to `chrome://extensions`
3. Enable "Developer mode"
4. Click "Load unpacked" and select the extracted folder
#### Firefox
1. Go to `about:addons`
2. Click the gear icon (⚙️) and select "Install Add-on From File..."
3. Navigate to and select the `artifacts/firefox.zip` file
> [!NOTE]
> For Firefox, installing unsigned extensions requires Firefox Developer Edition or Nightly.
> In Firefox Developer Edition, you need to set `xpinstall.signatures.required` to `false` in `about:config`.
[activitywatch]: https://github.com/ActivityWatch/activitywatch
[firefox]: https://addons.mozilla.org/en-US/firefox/addon/aw-watcher-web/
[chrome]: https://chromewebstore.google.com/detail/activitywatch-web-watcher/nglaklhklhcoonedhgnpgddginnjdadi
[mozilla-policy]: https://mozilla.github.io/policy-templates/
[gh-actions]: https://github.com/ActivityWatch/aw-watcher-web/actions/workflows/build.yml?query=branch%3Amaster+is%3Asuccess