ef8fa97e13
* chore: remove duplicate code of conduct * chore: remove AUTHORS file I doubt this actually has any value in the era of GitHub. * chore: move CODEOWNERS to toplevel * chore: move CONTRIBUTING.md to toplevel and adapt it * chore: remove duplicated LICENSE file * chore(engine): remove now-obsolete design document * chore: remove the testusing test We're not going to make this code importable from third parties like we did for probe-engine. It seems this feature was only used for the experiment in Spain so it makes sense to drop it. * chore: enable code generation tests See https://github.com/ooni/probe/issues/1335 * chore: enable code-ql checks * cleanup: remove libooniffi code and tests It seems this code is not used. We are not aware of anyone using it. And we don't want to expose it publicly as an API. So, what to do? I guess it's fine to delete it. If there is anyone that needs it, we have in the history a reference to it and we can always reinstate it. * chore: move issue templates to ooni/probe |
||
|---|---|---|
| .github/workflows | ||
| CLI | ||
| cmd/ooniprobe | ||
| data | ||
| debian | ||
| docs | ||
| internal | ||
| MOBILE | ||
| pkg | ||
| QA | ||
| .gitignore | ||
| build-android.bash | ||
| build-ios.bash | ||
| build-miniooni.sh | ||
| build.sh | ||
| CODE_OF_CONDUCT.md | ||
| CODEOWNERS | ||
| CONTRIBUTING.md | ||
| go.mod | ||
| go.sum | ||
| LICENSE.md | ||
| publish-android.bash | ||
| publish-ios.bash | ||
| Readme.md | ||
| smoketest.sh | ||
| testjafar.bash | ||
| updatebindata.sh | ||
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
ooniprobebinary into a location in your$PATH, for example/usr/local/bin/ooniprobe -
Run
ooniprobe runto 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 -
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.
<?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>ProgramArguments</key>
<array>
<string>/PATH/TO/BINARY/ooniprobe</string>
<string>--log-handler=syslog</string>
<string>run</string>
<string>unattended</string>
</array>
<key>StartInterval</key>
<integer>86400</integer>
</dict>
</plist>
Once you have written the file, you can enable ooniprobe to run automatically by
doing: launchctl load org.ooni.probe.cli.plist.
Reporting issues
Please, report issues with this codebase at https://github.com/ooni/probe. Please, make
sure you tag such issues using the ooni/probe-cli label.
Development setup
Be sure you have golang >= 1.14 and a C compiler (when developing for Windows, you need Mingw-w64 installed). The most basic build command is:
go build -v ./cmd/ooniprobe
To compile a release used the build.sh script. For more information
./build.sh help
The output generated by this command should provide you with updated information
regarding the pre-requisites for building (and cross-building) ooniprobe as well
as useful information regarding cross compiling.
To update bundled binary data use:
./updatebindata.sh
Updating dependencies
go get -u -v ./... && go mod tidy
Releasing
-
update binary data as described above;
-
update
internal/version/version.go; -
make sure you have updated dependencies;
-
run
./build.sh releaseand follow instructions.