Skip to content

Commit 650e23a

Browse files
committed
docs: update docs to mention cors_origins config for aw-server
1 parent cb76e4a commit 650e23a

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

src/configuration.rst

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,35 +13,36 @@ Configuration options for the server, client, and default watchers are listed be
1313
aw-server-python
1414
----------------
1515

16-
- :code:`host` Hostname to start the server on. Currently only :code:`localhost` or :code:`127.0.0.1` are supported.
17-
- :code:`port` Port number to start the server on.
18-
- :code:`storage` Type of storage for holding buckets and events. Supported types are :code:`peewee`, :code:`memory` (useful in testing), or :code:`mongodb` (MongoDB support will be removed in a future version).
16+
- ``host`` Hostname to start the server on. Currently only ``localhost`` or ``127.0.0.1`` are supported.
17+
- ``port`` Port number to start the server on.
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.
1920

2021
aw-server-rust
2122
--------------
2223

23-
- :code:`host` Hostname to start the server on. Currently only :code:`localhost` or :code:`127.0.0.1` are supported.
24-
- :code:`port` Port number to start the server on.
25-
- :code:`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.
24+
- ``host`` Hostname to start the server on. Currently only ``localhost`` or ``127.0.0.1`` are supported.
25+
- ``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.
2627

2728
aw-client
2829
---------
2930

30-
- :code:`server.hostname` Hostname of the server to connect to.
31-
- :code:`server.port` Port number of the server to connect to.
32-
- :code:`client.commit_interval` How often to commit events to the server (in seconds).
31+
- ``server.hostname`` Hostname of the server to connect to.
32+
- ``server.port`` Port number of the server to connect to.
33+
- ``client.commit_interval`` How often to commit events to the server (in seconds).
3334

3435
aw-watcher-afk
3536
--------------
3637

37-
- :code:`timeout` Time in seconds after which a period without keyboard or mouse activity is considered to be AFK (away from keyboard).
38-
- :code:`poll_time` Time in seconds between checks for activity.
38+
- ``timeout`` Time in seconds after which a period without keyboard or mouse activity is considered to be AFK (away from keyboard).
39+
- ``poll_time`` Time in seconds between checks for activity.
3940

4041
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.
4142

4243
aw-watcher-window
4344
-----------------
4445

45-
- :code:`poll_time` Time in seconds between window checks.
46-
- :code:`exclude_title` Don't track window titles
47-
- :code:`strategy_macos` The strategy to use on macOS to fetch the active window, can be "swift", "jxa" or "applescript". Swift strategy is preferred.
46+
- ``poll_time`` Time in seconds between window checks.
47+
- ``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.

0 commit comments

Comments
 (0)