You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/configuration.rst
+23-9Lines changed: 23 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,39 +10,53 @@ Other, more technical configuration options, are available through the config fi
10
10
11
11
Configuration options for the server, client, and default watchers are listed below:
12
12
13
-
aw-server-python
14
-
----------------
13
+
aw-server
14
+
---------
15
15
16
16
- ``host`` Hostname to start the server on. Currently only ``localhost`` or ``127.0.0.1`` are supported.
17
17
- ``port`` Port number to start the server on.
18
18
- ``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
+
20
24
21
25
aw-server-rust
22
26
--------------
23
27
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.
25
29
- ``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
+
27
35
28
36
aw-client
29
37
---------
30
38
31
39
- ``server.hostname`` Hostname of the server to connect to.
32
40
- ``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
+
34
45
35
46
aw-watcher-afk
36
47
--------------
37
48
38
49
- ``timeout`` Time in seconds after which a period without keyboard or mouse activity is considered to be AFK (away from keyboard).
39
50
- ``poll_time`` Time in seconds between checks for activity.
40
51
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.
42
53
43
54
aw-watcher-window
44
55
-----------------
45
56
46
-
- ``poll_time`` Time in seconds between window checks.
47
57
- ``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.
0 commit comments