diff --git a/Readme.md b/Readme.md index 7576960..4e15c34 100644 --- a/Readme.md +++ b/Readme.md @@ -20,6 +20,50 @@ 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. + +``` + + + + + Label + org.ooni.probe.daily-run + + KeepAlive + + RunAtLoad + + + Program + /PATH/TO/BINARY/ooniprobe + ProgramArguments + + --config="/PATH/TO/CONFIG/config-100sites.json" + --batch + run + + + StartInterval + 3600 + + StandardErrorPath + /tmp/ooniprobe-cli.err + + StandardOutPath + /tmp/ooniprobe-cli.out + + +``` + +Once you have written the file, you can enable to run automatically by doing: `launchctl load org.ooni.probe.cli.plist`. + ## Development setup Be sure you have golang >= 1.13. We use golang modules. Run