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
16 changes: 16 additions & 0 deletions src/directories.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,19 @@ Cache
- Windows: ``C:\Users\<USER>\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 <name>``. aw-qt passes the profile on to the modules it starts through the ``AW_PROFILE`` environment variable. When starting modules separately, set ``AW_PROFILE=<name>`` for each of them; ``aw-server``, ``aw-server-rust``, and ``aw-sync`` also accept ``--profile <name>``.

For a profile other than ``default``, every directory above uses ``activitywatch-<name>`` 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.
1 change: 1 addition & 0 deletions src/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <window-watchers>` which supports Wayland.
- Try the experimental Tauri distribution (starting with ``v0.14``), which bundles `awatcher <https://github.com/2e3s/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 <https://stackoverflow.com/questions/45465016/how-do-i-get-the-active-window-on-gnome-wayland>`_ or follow `the issue for ActivityWatch tracking the problem <https://github.com/ActivityWatch/activitywatch/issues/92>`_.

Expand Down
12 changes: 11 additions & 1 deletion src/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,15 @@ Installation

Download the ``.dmg`` for the `latest release from GitHub <https://github.com/ActivityWatch/activitywatch/releases/latest>`_ 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 <https://github.com/ActivityWatch/activitywatch/releases/latest>`_, unzip the archive into an appropriate directory, and add the ``aw-qt`` executable to your autostart applications.
The `latest release on GitHub <https://github.com/ActivityWatch/activitywatch/releases/latest>`_ 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-<version>-linux-x86_64.deb``.

.. note::
If you are using Arch Linux you can install using the official ``activitywatch-bin`` package in `the AUR <https://aur.archlinux.org/packages/activitywatch-bin/>`_.
Expand All @@ -34,6 +40,10 @@ Installation
Getting it to F-droid is a work-in-progress, see `this PR <https://gitlab.com/fdroid/fdroiddata/-/merge_requests/5502>`_.


.. 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 <https://github.com/2e3s/awatcher>`_ for native Wayland support. The classic distribution remains the default.


Usage
=====

Expand Down
2 changes: 2 additions & 0 deletions src/installing-from-source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/

Expand Down
Loading