From 1ee0145e11b9bc371ac50102d924f573b6dcf821 Mon Sep 17 00:00:00 2001 From: Michael Rienstra Date: Thu, 30 Oct 2025 22:18:30 -0700 Subject: [PATCH] configuration: more default links; small corrections / additions --- src/configuration.rst | 32 +++++++++++++++++++++++--------- src/watchers.rst | 2 ++ 2 files changed, 25 insertions(+), 9 deletions(-) diff --git a/src/configuration.rst b/src/configuration.rst index b2b746e..53f3fe2 100644 --- a/src/configuration.rst +++ b/src/configuration.rst @@ -10,27 +10,38 @@ Other, more technical configuration options, are available through the config fi Configuration options for the server, client, and default watchers are listed below: -aw-server-python ----------------- +aw-server +--------- - ``host`` Hostname to start the server on. Currently only ``localhost`` or ``127.0.0.1`` are supported. - ``port`` Port number to start the server on. - ``storage`` Type of storage for holding buckets and events. Supported types are ``peewee``, ``memory`` (useful in testing), or ``mongodb`` (MongoDB support will be removed in a future version). -- ``cors_origins`` Comma-separated list of allowed origins for CORS (Cross-Origin Resource Sharing). Useful in testing and development to let other origins access the ActivityWatch API, such as aw-webui in development mode on port 27180. +- ``cors_origins`` Comma-separated list of allowed origins for CORS (Cross-Origin Resource Sharing). Useful in testing and development to let other origins access the ActivityWatch API, such as ``aw-webui`` in development mode on port 27180. +- ``custom_static`` A mapping of watcher names to paths where custom visualizations are located, see `custom visualizations ` documentation. + +See `aw_server/config.py `_ for default config values. + aw-server-rust -------------- -- ``host`` Hostname to start the server on. Currently only ``localhost`` or ``127.0.0.1`` are supported. +- ``address`` Hostname to start the server on. Currently only ``localhost`` or ``127.0.0.1`` are supported. - ``port`` Port number to start the server on. -- ``cors`` List of allowed origins for CORS (Cross-Origin Resource Sharing). Useful in testing and development to let other origins access the ActivityWatch API, such as aw-webui in development mode on port 27180. +- ``cors`` List of allowed origins for CORS (Cross-Origin Resource Sharing). Useful in testing and development to let other origins access the ActivityWatch API, such as ``aw-webui`` in development mode on port 27180. +- ``custom_static`` A mapping of watcher names to paths where custom visualizations are located, see `custom visualizations ` documentation. + +See `aw-server/src/config.rs `_ for default config values. + aw-client --------- - ``server.hostname`` Hostname of the server to connect to. - ``server.port`` Port number of the server to connect to. -- ``client.commit_interval`` How often to commit events to the server (in seconds). +- ``client.commit_interval`` How often to commit events to the server, in seconds. + +See `aw_client/config.py `_ for default config values. + aw-watcher-afk -------------- @@ -38,11 +49,14 @@ aw-watcher-afk - ``timeout`` Time in seconds after which a period without keyboard or mouse activity is considered to be AFK (away from keyboard). - ``poll_time`` Time in seconds between checks for activity. -See `aw_watcher_afk/config.py `_ for the default config values. +See `aw_watcher_afk/config.py `_ for default config values. aw-watcher-window ----------------- -- ``poll_time`` Time in seconds between window checks. - ``exclude_title`` Don't track window titles -- ``strategy_macos`` The strategy to use on macOS to fetch the active window, can be "swift", "jxa" or "applescript". Swift strategy is preferred. +- ``exclude_titles`` Exclude window titles by regular expression. Can specify multiple times. Matches anywhere in the string, case insensitive. +- ``poll_time`` Time in seconds between window checks. +- ``strategy_macos`` The strategy to use on macOS to fetch the active window, can be ``swift``, ``jxa`` or ``applescript``. Swift strategy is preferred. + +See `aw_watcher_window/config.py `_ for default config values. diff --git a/src/watchers.rst b/src/watchers.rst index dded039..178b56f 100644 --- a/src/watchers.rst +++ b/src/watchers.rst @@ -84,6 +84,8 @@ Importers .. include:: importers.rst :start-line: 2 +.. _custom-visualizations: + Custom visualizations ---------------------