This repository contains OONI probe's measurement engine. That is, the piece of software that implements OONI nettests as well as all the required functionality to run such nettests.
We expect you to use the Go version indicated in go.mod.
We recommend pinning to a specific version of probe-engine:
go get -v github.com/ooni/probe-engine@VERSION
See also the workflows/using.yml test where we check that the latest commit can be imported by a third party.
We do not provide any API stability guarantee.
miniooni is a small command line client used for research and quality assurance testing. Build using:
go build -v ./cmd/miniooni/
See also ./build-cli.bash
for more advanced builds (e.g. to create
statically linked and/or stripped binaries).
We don't provide any miniooni
command line flags stability guarantee.
See
./miniooni --help
for more help.
./build-android.bash
We automatically build Android bindings whenever commits are pushed to the
mobile-staging
branch. Such builds could be integrated by using:
implementation "org.ooni:oonimkall:VERSION"
Where VERSION is like 2020.03.30-231914
corresponding to the
time when the build occurred.
./build-ios.bash
We automatically build iOS bindings whenever commits are pushed to the
mobile-staging
branch. Such builds could be integrated by using:
pod 'oonimkall', :podspec => 'https://dl.bintray.com/ooni/ios/oonimkall-VERSION.podspec'
Where VERSION is like 2020.03.30-231914
corresponding to the
time when the build occurred.
go get -u -v ./... && go mod tidy