Skip to content

Commit 1ee0145

Browse files
committed
configuration: more default links; small corrections / additions
1 parent aeef7d2 commit 1ee0145

File tree

2 files changed

+25
-9
lines changed

2 files changed

+25
-9
lines changed

src/configuration.rst

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,39 +10,53 @@ Other, more technical configuration options, are available through the config fi
1010

1111
Configuration options for the server, client, and default watchers are listed below:
1212

13-
aw-server-python
14-
----------------
13+
aw-server
14+
---------
1515

1616
- ``host`` Hostname to start the server on. Currently only ``localhost`` or ``127.0.0.1`` are supported.
1717
- ``port`` Port number to start the server on.
1818
- ``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).
19-
- ``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.
19+
- ``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.
20+
- ``custom_static`` A mapping of watcher names to paths where custom visualizations are located, see `custom visualizations <custom-visualizations>` documentation.
21+
22+
See `aw_server/config.py <https://github.com/ActivityWatch/aw-server/blob/master/aw_server/config.py>`_ for default config values.
23+
2024

2125
aw-server-rust
2226
--------------
2327

24-
- ``host`` Hostname to start the server on. Currently only ``localhost`` or ``127.0.0.1`` are supported.
28+
- ``address`` Hostname to start the server on. Currently only ``localhost`` or ``127.0.0.1`` are supported.
2529
- ``port`` Port number to start the server on.
26-
- ``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.
30+
- ``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.
31+
- ``custom_static`` A mapping of watcher names to paths where custom visualizations are located, see `custom visualizations <custom-visualizations>` documentation.
32+
33+
See `aw-server/src/config.rs <https://github.com/ActivityWatch/aw-server-rust/blob/master/aw-server/src/config.rs>`_ for default config values.
34+
2735

2836
aw-client
2937
---------
3038

3139
- ``server.hostname`` Hostname of the server to connect to.
3240
- ``server.port`` Port number of the server to connect to.
33-
- ``client.commit_interval`` How often to commit events to the server (in seconds).
41+
- ``client.commit_interval`` How often to commit events to the server, in seconds.
42+
43+
See `aw_client/config.py <https://github.com/ActivityWatch/aw-client/blob/master/aw_client/config.py>`_ for default config values.
44+
3445

3546
aw-watcher-afk
3647
--------------
3748

3849
- ``timeout`` Time in seconds after which a period without keyboard or mouse activity is considered to be AFK (away from keyboard).
3950
- ``poll_time`` Time in seconds between checks for activity.
4051

41-
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.
52+
See `aw_watcher_afk/config.py <https://github.com/ActivityWatch/aw-watcher-afk/blob/master/aw_watcher_afk/config.py>`_ for default config values.
4253

4354
aw-watcher-window
4455
-----------------
4556

46-
- ``poll_time`` Time in seconds between window checks.
4757
- ``exclude_title`` Don't track window titles
48-
- ``strategy_macos`` The strategy to use on macOS to fetch the active window, can be "swift", "jxa" or "applescript". Swift strategy is preferred.
58+
- ``exclude_titles`` Exclude window titles by regular expression. Can specify multiple times. Matches anywhere in the string, case insensitive.
59+
- ``poll_time`` Time in seconds between window checks.
60+
- ``strategy_macos`` The strategy to use on macOS to fetch the active window, can be ``swift``, ``jxa`` or ``applescript``. Swift strategy is preferred.
61+
62+
See `aw_watcher_window/config.py <https://github.com/ActivityWatch/aw-watcher-window/blob/master/aw_watcher_window/config.py>`_ for default config values.

src/watchers.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,8 @@ Importers
8484
.. include:: importers.rst
8585
:start-line: 2
8686

87+
.. _custom-visualizations:
88+
8789
Custom visualizations
8890
---------------------
8991

0 commit comments

Comments
 (0)