a9392f024a
You should place the file inside of: `$HOME/Library/LaunchAgents` and then enable by running `launchctl load org.ooni.probe.cli.plist` It assumes you have a `ooniprobe` binary in `~/.ooniprobe/ooniprobe` and a special config file named `/Users/USERNAME/.ooniprobe/config-100sites.json` with a URL limit of 100 sites per run: ``` "nettests": { "websites_url_limit": 100 }, ``` |
||
---|---|---|
cmd/ooniprobe | ||
config | ||
data | ||
docs | ||
internal | ||
nettests | ||
scripts | ||
testdata | ||
utils | ||
version | ||
.dockerignore | ||
.gitignore | ||
.travis.yml | ||
build.sh | ||
Dockerfile | ||
go.mod | ||
go.sum | ||
LICENSE.md | ||
ooni_test.go | ||
ooni.go | ||
Readme.md |
OONI Probe CLI
The next generation OONI Probe Command Line Interface.
User setup
-
Go into the releases and download the release for your architecture and platform
-
Extract the tarball with
tar xvzf ooniprobe_*.tar.gz
-
Copy the
ooniprobe
binary into a location in your$PATH
, for example/usr/local/bin/ooniprobe
-
Run
ooniprobe run
to perform all the tests
Optional:
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 -
Development setup
Be sure you have golang >= 1.13. We use golang modules. Run
./build.sh help
to get information on the supported systems as well as to get instructions on how to install dependencies.
Updating dependencies
-
update every direct dependency in
go.mod
exceptprobe-engine
usinggo get -u -v $dependency
-
pin to the latest version of the
probe-engine
withgo get -v github.com/ooni/probe-engine@tag
-
remove all indirect dependencies from
go.mod
and merge the content ofprobe-engine
'sgo.mod
into ourgo.mod
-
go mod tidy
The rationale of this procedure is that we want to pin exactly to a specific version of psiphon and of its dependencies.
Releasing
./build.sh release
and follow instructions.