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
32 changes: 23 additions & 9 deletions src/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,39 +10,53 @@ 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 <custom-visualizations>` documentation.

See `aw_server/config.py <https://github.com/ActivityWatch/aw-server/blob/master/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 <custom-visualizations>` documentation.

See `aw-server/src/config.rs <https://github.com/ActivityWatch/aw-server-rust/blob/master/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 <https://github.com/ActivityWatch/aw-client/blob/master/aw_client/config.py>`_ for default config values.


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 <https://github.com/ActivityWatch/aw-watcher-afk/blob/master/aw_watcher_afk/config.py>`_ for the default config values.
See `aw_watcher_afk/config.py <https://github.com/ActivityWatch/aw-watcher-afk/blob/master/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 <https://github.com/ActivityWatch/aw-watcher-window/blob/master/aw_watcher_window/config.py>`_ for default config values.
2 changes: 2 additions & 0 deletions src/watchers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ Importers
.. include:: importers.rst
:start-line: 2

.. _custom-visualizations:

Custom visualizations
---------------------

Expand Down