Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document modules for supporting Wayland more clearly #146

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Document modules for supporting Wayland more clearly #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
efcf1ae
Make the install from source page easier to find
Feb 3, 2025
48dd40c
Warn about Wayland support
Feb 3, 2025
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
7 changes: 7 additions & 0 deletions src/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ Installation
.. note::
Getting it to F-droid is a work-in-progress, see `this PR <https://gitlab.com/fdroid/fdroiddata/-/merge_requests/5502>`_.

.. group-tab:: Source

If you prefer to build ActivityWatch from source, check out :doc:`this guide <installing-from-source>` instead.


Usage
=====
Expand All @@ -48,6 +52,9 @@ If you want more advanced ways to run ActivityWatch (including running it withou
.. 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`.

.. note::
If your Linux system is using Wayland rather than X11, the default watchers will not work. Read :ref:`window and idle watchers for Wayland<wayland-watchers>`.

.. 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
3 changes: 3 additions & 0 deletions src/installing-from-source.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ If you want to ensure you have the latest version of all submodules, preserving

git submodule foreach --recursive git pull

.. note::
If your Linux system is using Wayland rather than X11, the default watchers will not work. Read :ref:`window and idle watchers for Wayland<wayland-watchers>` for replacement modules supporting Wayland.

Checking dependencies
---------------------

Expand Down
19 changes: 11 additions & 8 deletions src/watchers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,27 @@ Watchers

Watchers are the parts of ActivityWatch that do all the data collecting.

ActivityWatch comes with two watchers enabled by default:
ActivityWatch comes with two watchers enabled by default supporting Windows, macOS and Linux (X11 only):

- :gh-aw:`aw-watcher-afk` - Watches for mouse & keyboard activity to detect if the user is active (by default, an inactive period of at least 3 minutes is flagged as AFK: away from keyboard).
- :gh-aw:`aw-watcher-window` - Watches the active window, its title, and it's url (on Chrome-based browsers & Safari).

These default watchers are collecting some of the most important data.
But there is more to collect, so here are some other watchers that let you do so.

.. _window-watchers:
.. note::
For Wayland, see :ref:`wayland-watchers`.

Window watchers
---------------
.. _wayland-watchers:

Window and idle watchers for Wayland
-------------------------------------------

Watches the active window, its title, and application name.
Replaces :gh-aw:`aw-watcher-window` and :gh-aw:`aw-watcher-afk` to support Wayland, see issue :issue:`92`.

- :gh-aw:`aw-watcher-window` - The official window watcher for Windows, macOS, and Linux (X11 only).
- :gh-aw:`aw-watcher-window-wayland` - A window watcher for Wayland, by :gh-user:`johan-bjareholt`.
- :gh:`2e3s/awatcher` - A compiled watcher for X11 and Wayland to replace default window and AFK watchers, by :gh-user:`2e3s`.
- :gh-aw:`aw-watcher-window-wayland` - A window and idle watcher for Wayland, by :gh-user:`johan-bjareholt`, supports Posh, Sway.
- :gh:`2e3s/awatcher` - A compiled window and idle watcher for X11 and Wayland to replace default window and AFK watchers,
by :gh-user:`2e3s`, supports Sway, Hyprland, KDE, GNOME, and X11.

Browser watchers
----------------
Expand Down