Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion src/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@ Getting started

Getting started with ActivityWatch is as easy as installing, starting it, and setting up autostart (if your installation method doesn't do it for you).

System requirements
===================

The release builds are produced and tested on the following platforms. Older systems may work, but are not tested.

- **Windows**: Windows 10 or later (x64; ARM64 builds are available for Windows 11).
- **macOS**: macOS 12 (Monterey) or later. Releases are built with a deployment target of 12.0, so older versions fail at launch with errors such as ``dyld: Library not loaded: libswift_Concurrency.dylib``.
- **Linux**: a distribution with glibc 2.35 or newer (the release is built on Ubuntu 22.04, so e.g. Ubuntu 22.04+, Debian 12+, Fedora 36+). Older distributions fail with ``GLIBC_2.xx not found`` errors; use a newer distribution or `build from source <installing-from-source>`_.
- **Android**: see the `Play Store listing <https://play.google.com/store/apps/details?id=net.activitywatch.android>`_ for the supported Android versions.

Installation
============

Expand Down Expand Up @@ -46,7 +56,7 @@ You should now also have the web interface running at `<localhost:5600>`_ and wi
If you want more advanced ways to run ActivityWatch (including running it without aw-qt), check out the "Running" section of `installing-from-source`.

.. note::
If you are running GNOME 3 or another desktop environment that does not support system trays, or if for some reason Qt can't be used on your machine, read `Running on GNOME`.
If you are running GNOME or another desktop environment that does not show system tray icons, install the `AppIndicator and KStatusNotifierItem Support <https://extensions.gnome.org/extension/615/appindicator-support/>`_ extension to get the tray icon back. If that is not an option, or if for some reason Qt can't be used on your machine, read `Running on GNOME`.

.. note::
If you are using a proxy ActivityWatch might not work out of the box. To fix this you can set the environment variable ``NO_PROXY`` to include ``127.0.0.1`` before starting aw-qt. How to set an environment variable depends on your operating system; use Google if you are unsure how to do this.
Expand Down
2 changes: 2 additions & 0 deletions src/running-on-gnome.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Running on GNOME
================

The ``aw-qt`` tray icon works on GNOME if you install the `AppIndicator and KStatusNotifierItem Support <https://extensions.gnome.org/extension/615/appindicator-support/>`_ extension (it ships by default in some distributions such as Ubuntu). If you can't or don't want to use it, read on.

As an alternative for users of GNOME 3 and other desktop environments that don't support app trays, or simply to avoid depending on Qt, you can place two simple workaround scripts in your ActivityWatch install folder:

:code:`start.sh`:
Expand Down
2 changes: 1 addition & 1 deletion src/watchers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Browser watchers

Watches properties of the active browser tab like title, URL, audible and incognito state.

- :gh-aw:`aw-watcher-web` - The official browser extension, supports Chrome, Edge, and Firefox.
- :gh-aw:`aw-watcher-web` - The official browser extension, supports Chrome, Edge, and Firefox. Install it from the `Chrome Web Store <https://chromewebstore.google.com/detail/activitywatch-web-watcher/nglaklhklhcoonedhgnpgddginnjdadi>`_ (Chrome and other Chromium-based browsers) or `Firefox Add-ons <https://addons.mozilla.org/en-US/firefox/addon/aw-watcher-web/>`_.

Editor watchers
---------------
Expand Down
Loading