Skip to content

High-performance implementation of the ActivityWatch server, written in Rust

License

Notifications You must be signed in to change notification settings

ActivityWatch/aw-server-rust

Repository files navigation

aw-server-rust

Build Status Coverage Status Dependency Status

A reimplementation of aw-server in Rust.

Features missing compared to the Python implementation of aw-server:

  • API explorer (Swagger/OpenAPI)

How to compile

Build with cargo:

cargo build --release

You can also build with make, which will build the web assets as well:

make build

Your built executable will be located in ./target/release/aw-server-rust. If you want to use it with a development version of aw-qt you'll want to copy this binary into your venv:

cp target/release/aw-server ../venv/bin/aw-server-rust

How to run

If you want to quick-compile for debugging, run cargo run from the project root:

cargo run --bin aw-server

NOTE: This will start aw-server-rust in testing mode (on port 5666 instead of port 5600).

Configuration

The server reads its configuration from ~/.config/activitywatch/aw-server-rust/config.toml (or config-testing.toml in testing mode).

Available options:

# Address to listen on
#address = "127.0.0.1"

# Port to listen on (default: 5600, testing: 5666)
#port = 5600

# Additional exact CORS origins to allow (e.g. for custom web interfaces)
#cors = ["http://localhost:3000"]

# Additional regex CORS origins to allow (e.g. for sideloaded browser extensions)
#cors_regex = ["chrome-extension://yourextensionidhere"]

Custom CORS Origins

By default, the server allows requests from:

  • The server's own origin (http://127.0.0.1:<port>, http://localhost:<port>)
  • The official Chrome extension (chrome-extension://nglaklhklhcoonedhgnpgddginnjdadi)
  • All Firefox extensions (moz-extension://.*)

To allow additional origins (e.g. a sideloaded Chrome extension), add them to your config:

# Allow a specific sideloaded Chrome extension
cors_regex = ["chrome-extension://jmdbkmbphoikckgkcnpoojbfeiaoaocl"]

# Or allow all Chrome extensions (less secure, but convenient for development)
cors_regex = ["chrome-extension://.*"]

Syncing

For details about aw-sync-rust, see the README in its subdirectory.

About

High-performance implementation of the ActivityWatch server, written in Rust

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors