From 1f56f1391f48358b76ad1f0f0dd24309fa758ce8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Arturo=20Filast=C3=B2?= <arturo@filasto.net>
Date: Wed, 29 Jan 2020 09:43:39 +0100
Subject: [PATCH] Move launchd script into the Readme

---
 Readme.md                        | 42 ++++++++++++++++++++++++++++++++
 scripts/org.ooni.probe.cli.plist | 34 --------------------------
 2 files changed, 42 insertions(+), 34 deletions(-)
 delete mode 100644 scripts/org.ooni.probe.cli.plist

diff --git a/Readme.md b/Readme.md
index 7576960..ae0bcae 100644
--- a/Readme.md
+++ b/Readme.md
@@ -20,6 +20,48 @@ Add a crontab entry (on linux) to run `ooniprobe` daily at a random time:
 (crontab -l 2>/dev/null; echo "$(( ( RANDOM % 60 )  + 1 )) $(( ( RANDOM % 24 )  + 1 )) * * * ooniprobe run") | crontab -
 ```
 
+On macOS you can configure OONI Probe to run automatically using launchd.
+
+Below is a sample launchd script, that should be placed inside of `~/Library/LaunchAgents/org.ooni.probe.cli.plist`.
+
+Be sure to replace `/PATH/TO/BINARY/ooniprobe` with the actual install location of the `ooniprobe` binary and `/PATH/TO/CONFIG/config-100sites.json` with the location of a file which limits the testing to 100 URLs.
+
+You may also want to adjust the locations of the logs.
+
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>Label</key>
+    <string>org.ooni.probe.daily-run</string>
+
+    <key>KeepAlive</key>
+    <false/>
+    <key>RunAtLoad</key>
+    <true/>
+
+    <key>Program</key>
+    <string>/PATH/TO/BINARY/ooniprobe</string>
+    <key>ProgramArguments</key>
+    <array>
+        <string>--config="/PATH/TO/CONFIG/config-100sites.json"</string>
+        <string>--batch</string>
+        <string>run</string>
+    </array>
+
+    <key>StartInterval</key>
+    <integer>3600</integer>
+
+    <key>StandardErrorPath</key>
+    <string>/tmp/ooniprobe-cli.err</string>
+
+    <key>StandardOutPath</key>
+    <string>/tmp/ooniprobe-cli.out</string>
+</dict>
+</plist>
+```
+
 ## Development setup
 
 Be sure you have golang >= 1.13. We use golang modules. Run
diff --git a/scripts/org.ooni.probe.cli.plist b/scripts/org.ooni.probe.cli.plist
deleted file mode 100644
index 306c10b..0000000
--- a/scripts/org.ooni.probe.cli.plist
+++ /dev/null
@@ -1,34 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-    <key>Label</key>
-    <string>org.ooni.probe.daily-run</string>
-
-    <key>KeepAlive</key>
-    <false/>
-    <key>RunAtLoad</key>
-    <true/>
-
-    <key>Program</key>
-    <string>/Users/USERNAME/.ooniprobe/ooniprobe</string>
-    <key>ProgramArguments</key>
-    <key>ProgramArguments</key>
-    <array>
-        <string>--config="/Users/USERNAME/.ooniprobe/config-100sites.json"</string>
-        <string>--batch</string>
-        <string>run</string>
-    </array>
-
-    <key>StartInterval</key>
-    <integer>3600</integer>
-
-    <key>StandardErrorPath</key>
-    <string>/tmp/ooniprobe-cli.err</string>
-
-    <key>StandardOutPath</key>
-    <string>/tmp/ooniprobe-cli.out</string>
-</dict>
-</plist>
-
-