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: aw-sync/README.md
+24-2
Original file line number
Diff line number
Diff line change
@@ -8,14 +8,36 @@ Works by syncing local buckets with a special folder, which in turn should be sy
8
8
9
9
## Usage
10
10
11
-
TODO: Write usage instructions for how to use with a normal testing/staging (5666) instance, to actually sync between devices.
11
+
NOTE: Basic usage not quite ready yet, see the below testing sections for MVP usage.
12
12
13
13
```
14
14
cargo run --bin aw-sync-rust -- --port 5666 --help
15
15
```
16
16
17
+
## Testing with real data on a testing instance
17
18
18
-
## Testing
19
+
To test syncing real events to a sync folder which can then be pulled from, we will use some helper scripts to do the following:
20
+
21
+
1.`./test-sync.sh`
22
+
- Creates a sync directory **for you to set up sync** with Syncthing/Dropbox/Gdrive/rclone/whatever
23
+
- By default `~/ActivityWatchSync`
24
+
- Creates a datastore for the current host in the sync folder
25
+
- Sync all local buckets of interest (window & afk buckets, by default) to the sync dir
26
+
27
+
2.`./test-server.sh`
28
+
- Starts a testing server **on port 5667** using a temporary directory as datastore (`/tmp/...`)
29
+
30
+
3.`./test-import-sync.sh`
31
+
- Imports all the events from sync folder into the testing server on port 5667
32
+
33
+
4. You should now have all events synced to a local testing instance!
34
+
- You can browse [127.0.0.1:5667](http://127.0.0.1:5667) to view testing instance, where you'll see events from synced all hosts.
35
+
- You can now set up syncing for `~/ActivityWatchSync` on more devices, and on each one use the script `./test-sync.sh` to push their events into the sync folder, then run `./test-import-sync.sh` on the device where you have the testing instance to update the data there.
36
+
37
+
In the end, You should get something like this: https://twitter.com/ErikBjare/status/1519399784234246147
38
+
39
+
40
+
## Testing with fake data
19
41
20
42
**Note:** this documents usage for testing, it is not yet ready for production usage.
0 commit comments