From ff9cdbeffba36a8bdd7fda9ff717f883084ddabe Mon Sep 17 00:00:00 2001 From: Brayo Date: Sun, 4 Oct 2026 17:31:47 +0300 Subject: [PATCH] docs: document profiles, new install formats, and the Tauri distribution --- src/directories.rst | 16 ++++++++++++++++ src/faq.rst | 1 + src/getting-started.rst | 12 +++++++++++- src/installing-from-source.rst | 2 ++ 4 files changed, 30 insertions(+), 1 deletion(-) diff --git a/src/directories.rst b/src/directories.rst index 5b397a3..92bc09d 100644 --- a/src/directories.rst +++ b/src/directories.rst @@ -48,3 +48,19 @@ Cache - Windows: ``C:\Users\\AppData\Local\activitywatch\aw-server-rust\cache`` - macOS: ``~/Library/Caches/activitywatch/aw-server-rust`` - Linux: ``~/.cache/activitywatch/aw-server-rust`` + +.. _profiles: + +Profiles +-------- + +Starting with ``v0.14``, you can run named profiles. A profile is an isolated ActivityWatch instance with its own data, config, and logs, which can run at the same time as your normal instance. The ``default`` profile is the normal install, and ``testing`` is the profile used by the ``--testing`` flag (which runs on port 5666). + +To start a profile, run ``aw-qt --profile ``. aw-qt passes the profile on to the modules it starts through the ``AW_PROFILE`` environment variable. When starting modules separately, set ``AW_PROFILE=`` for each of them; ``aw-server``, ``aw-server-rust``, and ``aw-sync`` also accept ``--profile ``. + +For a profile other than ``default``, every directory above uses ``activitywatch-`` in place of ``activitywatch``. For example, the Linux data directory for a profile named ``research`` is ``~/.local/share/activitywatch-research/aw-server-rust``. + +Profile names must be lowercase letters, digits, ``-`` or ``_`` (starting with a letter or digit), and at most 32 characters. + +.. note:: + A named profile uses port 5600 unless configured otherwise, which collides with your default instance. Set a different ``port`` in that profile's server and ``aw-client`` config files (see :doc:`configuration`) before running both at once. diff --git a/src/faq.rst b/src/faq.rst index 5f324d7..8d89037 100644 --- a/src/faq.rst +++ b/src/faq.rst @@ -101,6 +101,7 @@ Unfortunately, in Wayland compositors like Gnome's Mutter there is no way at all - Switch to using X11. - Try an alternative AFK and window :ref:`watcher ` which supports Wayland. +- Try the experimental Tauri distribution (starting with ``v0.14``), which bundles `awatcher `_ on Linux for Wayland support. See :doc:`getting-started`. You can see the general status of the ability of `getting the active window in Wayland on StackOverflow `_ or follow `the issue for ActivityWatch tracking the problem `_. diff --git a/src/getting-started.rst b/src/getting-started.rst index 5acec25..f864a8e 100644 --- a/src/getting-started.rst +++ b/src/getting-started.rst @@ -19,9 +19,15 @@ Installation Download the ``.dmg`` for the `latest release from GitHub `_ and drag the ``.app`` to your Applications folder as usual, then add it to your autostart applications. + Starting with ``v0.14``, there are separate downloads for Apple Silicon (``arm64``) and Intel (``x86_64``) Macs. Pick the one matching your Mac. + .. group-tab:: Linux - Download the `latest release from GitHub `_, unzip the archive into an appropriate directory, and add the ``aw-qt`` executable to your autostart applications. + The `latest release on GitHub `_ is available in several formats: + + - ``.zip``: unzip the archive into an appropriate directory, and add the ``aw-qt`` executable to your autostart applications. + - ``.AppImage``: make the file executable (``chmod +x``) and run it. + - ``.deb`` (Debian, Ubuntu, and derivatives): install it with your package manager, e.g. ``sudo apt install ./activitywatch--linux-x86_64.deb``. .. note:: If you are using Arch Linux you can install using the official ``activitywatch-bin`` package in `the AUR `_. @@ -34,6 +40,10 @@ Installation Getting it to F-droid is a work-in-progress, see `this PR `_. +.. note:: + Starting with ``v0.14``, each release also offers an experimental Tauri distribution (files named ``activitywatch-tauri-*``). It replaces the ``aw-qt`` tray app, embeds ``aw-server-rust``, and on Linux bundles `awatcher `_ for native Wayland support. The classic distribution remains the default. + + Usage ===== diff --git a/src/installing-from-source.rst b/src/installing-from-source.rst index 9983007..f35879e 100644 --- a/src/installing-from-source.rst +++ b/src/installing-from-source.rst @@ -108,6 +108,8 @@ There are two ways to run ActivityWatch: Both methods take the :code:`--testing` flag as a command line parameter to run in testing mode. This runs the server on a different port (5666) and uses a separate database file to avoid mixing your important data with your testing data. +To run another isolated instance alongside your normal one, use a named profile instead, see :ref:`profiles`. + Now everything should be running! Check out the web UI at http://localhost:5600/